Documentation v2 - Githubissues

smartcar / javascript-sdk

Client-side JS SDK for OAuth dialogs.

MIT License

9 stars 5 forks source link

Documentation v2 #34

Closed sankethkatta closed 5 years ago

sankethkatta commented 5 years ago

Reorganize and rewrite README for clarity. See it here:
- documentation-v2/README.md
Autogenerate reference documentation with jsdoc-to-markdown. See in:
- documentation-v2/doc/README.md
Template package version number into README using gulp-template. All changes to README should now be made in README.mdt and templated using npm run readme.
Method references are linked from README into the autogenerated JSDoc.

sankethkatta commented 5 years ago

@charlottekosche I addressed your comments in the latest commit. Please look through and let me know if it looks good! The "Server side redirect" section might still need some work.