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.

Sign up for GitHub

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

Jump to bottom

Rework README before 1.0 #20

Open
jdickey opened this issue Dec 18, 2018 · 0 comments
Open

Rework README before 1.0 #20

jdickey opened this issue Dec 18, 2018 · 0 comments
Labels
documentation Documentation for self, collaborators, stakeholders, or others
Milestone
Version 1.0

Comments

@jdickey
Copy link
Owner

jdickey commented Dec 18, 2018

The link from the README to the API doc doesn't work. That obviously needs fixing.

Also, the Use Case Workflows descriptive section is really too long for a README; a short summary of the API might be better. The existing workflow documentation should live on as a separate document.
@jdickey jdickey added the documentation Documentation for self, collaborators, stakeholders, or others label Dec 18, 2018
@jdickey jdickey added this to the Version 1.0 milestone Dec 18, 2018
jdickey added a commit that referenced this issue Dec 18, 2018
@jdickey
Prepare for 0.1.0 Gem release; add HISTORY.md
ddffc96 
* One issue known to need resolution prior to 1.0.0 release (#20);
* One has been  moved to _The Glorious Future™_ milestone (#16); and
* One has simply been labelled `wontfix` with no milestone specified (#14).

81 tests, 110 assertions, 0 failures, 0 errors, 0 skips
Coverage: 918 / 918 LOC (100.0%) covered.
RuboCop: 11 files inspected, no offenses detected
Flay: Total score 0
Flog: Total 329.8; method average 4.6; max 9.8 (CryptIdent::SignUp#create_result)
Reek: 0 total warnings
Inch: Nothing to suggest
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Documentation for self, collaborators, stakeholders, or others
Projects
None yet
Milestone
Version 1.0
Development

No branches or pull requests
1 participant
@jdickey