search

digitalbazaar / base64url-universal

Encode/decode "Base64url Encoding" format of JSON Web Signature (JWS) RFC7517.
Other
5 stars 4 forks source link

Update documentation and readme. #3

Open mattcollier opened 5 years ago

mattcollier commented 5 years ago

Notably, the documentation should indicate that node.js users can pass a node Buffer into the encode API and that the decode API in node.js returns a Buffer.

Ideally this could be done in some automated way. The existing readme was automatically generated using this tool: https://github.com/jsdoc2md/jsdoc-to-markdown

davidlehn commented 5 years ago

Also, there should be a script or something to update the README. I'm not sure what to do to update it and add special README bits like a travis badge.

aljones15 commented 5 years ago

https://docs.travis-ci.com/user/status-images/

On Wed, Jul 3, 2019 at 1:33 PM David I. Lehn notifications@github.com wrote:

Also, there should be a script or something to update the README. I'm not sure what to do to update it and add special README bits like a travis badge.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/digitalbazaar/base64url-universal/issues/3?email_source=notifications&email_token=AACD6CGEJDC2WLW355NPDN3P5TPF3A5CNFSM4GYVPOUKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZFFEJI#issuecomment-508187173, or mute the thread https://github.com/notifications/unsubscribe-auth/AACD6CAWWTIK6W3UKJLJFE3P5TPF3ANCNFSM4GYVPOUA .

davidlehn commented 5 years ago

@aljones15 We use those in many projects. The problem is where to add that here? The current README.md is generated so we can't modify it. We need to add deps, setup a generation script, and add a template with normal README info, including badges, that would have a generated API section.

aljones15 commented 5 years ago

there should be/ could be a template file that contains it. amount of work to do that though is probably about 2 hours as the read me generator's documentation on how their moustache template works is pretty bad.

On Wed, Jul 3, 2019 at 2:47 PM David I. Lehn notifications@github.com wrote:

@aljones15 https://github.com/aljones15 We use those in many projects. The problem is where to add that here? The current README.md is generated so we can't modify it. We need to add deps, setup a generation script, and add a template with normal README info, including badges, that would have a generated API section.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/digitalbazaar/base64url-universal/issues/3?email_source=notifications&email_token=AACD6CB5SJH4DZ76ENJLFSLP5TX47A5CNFSM4GYVPOUKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZFLRCQ#issuecomment-508213386, or mute the thread https://github.com/notifications/unsubscribe-auth/AACD6CAWRNZTJPH2OQMUKDTP5TX47ANCNFSM4GYVPOUA .