Merge branch 'Local.Dev.Next' into Local.Dev.Current

README.md

@@ -1,5 +1,5 @@
 # Serius-Destiny-API-Wrapper
-
+## What Is It???
 S-DAW
    or   
 SDAW
@@ -8,4 +8,78 @@ SeriusDAW
 
 SDAW is short for _"Serius Destiny API Wrapper"._
 
-This is to be a public Destiny 2 API Wrapper. It will focus on C#.NET (Framework.4.7+ AND CORE.3+)...
+This is to be a public Destiny 2 API Wrapper _(D1 API Wrapper **may or may not** be added at a later date, but folder structure will be present)._
+
+## Wrapper Focus
+It will focus on C#.NET (Framework.4.7+ AND CORE.3+) but may possibly (in the future) include VB.NET, PHP, Golang, C++, Java, JavaScript, Ruby, AND/OR python wrappers.
+
+## With Benefits...
+The wrappers serve both to simplify consumption of Bungie's Destiny 2 API AND to provide an example of how to consume said API. Documentation built during the development of this API Wrapper will likely be shared with the Bungie API dev(s) so that they can pass it along to people:
+
+> 1. newbie and veteran developers
+> 1. inexperienced and fluent WebAPI consumers
+> 1. and everyone in between...
+
+## Documentation
+
+### Documentation Flavors
+So, the documentation, if you decide to help with, needs to come in two flavors:
+> 1. Quick-Burn Guide for those that just need to know the major bullet points and info to plug into their experienced workflow...
+> 1. Detailed, Specific, AND Simple Guide that details how to get started, what a web API is, how it functions, and how to consume it. This guide will be from the perspective of a semi-experienced developer (or even developer-in-training) that assumes basic knowledge of programming in their language of choice. It will need to be language-agnostic where possible while utilizing a language statically so that they can use the documentation in full for their own project(s).
+
+#### Documentation Flavors - Quick, Dirty, and Simple
+Assuming that the first guide (the quick, dirty, and specific guid) is for devs that know what they are doing in their own programming language AND know how to consume a webAPI (specifically, OAth2 is the security/user/login standard in use, so assume they are familiar with it). Examples generally will be limited to the fewest necessary but provide detailed specifics that can be plugged in on their own. When using actual code, there will be specific languages I personally plan to support and then the opening will be up for other languages that you want to help with (the more, the merrier, to a reasonable limit, that is)...
+
+#### How to Help
+> If you wish to help with this, please fork this repo, limit changes/additions/updates to specific tasks, and do a PR and I'll take a look as time permits, code-review where necessary and push through if all goes well. Please keep updates to specific tasks (i.e. a mass dump will be both impossible/improbable to check, verify and give the OK on AND risks putting the Repo into a bad state. Multiple PR's limited in scope is preferable to one or two big ones. Please include useful comments telling what, why, and any pre-req's (such as previous PRs that the current PR depends on)...
+
+### Documentation AIMs & Goals
+I HOPE that the documentation can be similar to how the previously MSDN and currently Microsoft Docs paradigm where-in language agnostic information is shared in the main documents and examples are provided for ALL languages that are being supported. For instance, they might have a document that explains the System.String type for the .NET Framework, .NET Standard AND .NET CORE. They provide the ability to see how the information changes between versions of the .NET fwk/CORE/Std. They ALSO allow you to see the individual code samples in your language of choice. You can pick from C#, VB.NET, F#, C++, and sometimes, even JavaScript and other languages!
+
+## Wrapper AND Documentation Language Support
+
+### Languages I plan to support from the get-go:
+> 1. C# (.NET Fwk 4.7+, and .NET Core 3.0+)...
+>  1. Possibly will include any gotchas/differences from CORE 3.0+ to Standard 2.x+ ...
+> 1. VB.NET (.NET Fwk 4.7+)
+
+### Languages I HOPE to support at a later date, but MAY need help with:
+> 1. PHP
+> 1. C++
+> 1. Golang
+> 1. Ruby
+> 1. JavaScript
+
+### Languages I would LIKE to support but will DEFINITELY need help with:
+> 1. python
+> 1. JavaScript / TypeScript
+> 1. Java / Kotlin
+> 1. JavaScript's Most Popular Frameworks:
+>  1. Angular
+>  1. jQuery
+>  1. React
+>  1. Node
+>  1. Vue
+>  1. Mithril
+> 1. Rust
+> 1. Haskell / Erlang
+> 1. Swift / Objective-C / XCode
+> 1. Delphi
+> 1. Perl
+> 1. R
+
+## Suggestions/Requests
+> If you want to include work for a new programming language, please, to save yourself time, send me a DM/Email OR a quick PR with an update to the Supported-Languages.md file indicating ALL of the following:
+> 1. the language you wish to add support and/or documentation for
+> 1. WHY you wish to include this other language (is this commonly used for webapps/desktop-apps/mobile-apps? is it different enough from existing languages that one would not likely be able to figure it out given the currently supported languages? ...etc...
+> 1. are you providing JUST documentation on how to consume the API in said language, creating a wrapper, OR **BOTH** ???
+> 1. If doing the wrapper, can you complete the wrapper on your own without additional effort of myself or others? Will it encompass all aspects or just specific aspects of the Bungie D2 API? If only parts, which parts will you be supporting _(OAth2, User Registration, User Linking, Cookies, Search, User Info, Clan Info, Viewing Gear, Searching the Database, Equipping Gear, Milestone/Bounty/Quest search, Milestone/Bounty/Quest per-user, etc)_ ???
+> Assuming all goes well and the PR is approved, the wrapper code will be updated here (as will the documentation), but the documentation itself will ALSO be funneled into a separate Documentation Repo. Please provide your information you wish included with your documentation and wrapper code so that it can be passed along (contact info, any pre-req's for the licensing model you accept usage of based on your consuming and adding to this project specifically. _NOTE: At the time of writing this initially, we are utilizing the MIT licensing scheme so that others can use our project however they see fit, BUT we may be required to update our licensing scheme to accomodate the licensing scheme utilized by Bungie's Destiny 1 & Destiny 2 Public Facing APIs) which may also affect your licensing and protections. If you are sharing your work with this project, it is assumed that you agree to the licensing scheme necessary for both This project AND the Bungie Destiny APIs as well.
+
+We look forward to seeing you however you may be consuming this wrapper, documentation, or efforts. If you wish to help in some way, be it monetarily, in spiritual cheers, or code/documentation additions, please get into contact with us. We look forward to your assistance. :)
+
+Contact Info:
+> 1. Discord:
+>   1. DudeSerius#5435
+> 1. Email:
+>   1. Nathan.VanBuskirk+git_aspnix@SeriusSoft.com