Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README rejig #27

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

README rejig #27

wants to merge 1 commit into from

Conversation

eadmundo
Copy link
Member

@eadmundo eadmundo commented Sep 9, 2020

I want to restructure and simplify the README. There's loads of good content in there, but I think it's more verbose than it needs to be, and we should structure it to focus on a more basic use case initially - the IETF draft standard is pretty complex compared to e.g. Shopify. We also should document the options themselves rather than only through the default methods.

The TOC was a bit deeply indented and intimidating, perhaps we don't need it.

I've started to structure it like this:

  • Brief description
  • Install
  • Usage [by code example, really]
  • Options [in more of an API-doc format]
  • IETF draft standard [explanation of how this works - lots of the content can go here]
  • Shopify?

I am wondering if before we go deeply into perfecting this README we should extract the IETF hmac methods into a external lib

@eadmundo eadmundo changed the base branch from main to feature/calculate-body-digest September 9, 2020 23:06
@eadmundo eadmundo changed the base branch from feature/calculate-body-digest to feat/signature-encoding-options September 9, 2020 23:07
@eadmundo eadmundo changed the base branch from feat/signature-encoding-options to main September 10, 2020 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant