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

Add basic usage information on README [skip ci] #673

Closed
wants to merge 1 commit into from
Closed

Add basic usage information on README [skip ci] #673

wants to merge 1 commit into from

Conversation

kroggen
Copy link

@kroggen kroggen commented Oct 11, 2019

This may not be so good documentation, but at least it is a start. Feel comfortable to fix it.

#672

@kroggen
Copy link
Author

kroggen commented Oct 11, 2019

What about changing "key generation" on README to "public key generation"?

jonasnick
jonasnick reviewed Oct 11, 2019
View reviewed changes
Copy link
Contributor

@jonasnick jonasnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in favor of adding a Usage section, but the bullet points in this PR seem a bit out of place. Much more helpful would be to provide examples for pubkey generation, signing and verification and add a link to the include files for the documentation.

@real-or-random real-or-random linked an issue May 8, 2020 that may be closed by this pull request
Documentation should provide example callers. #184
Closed
@real-or-random
Copy link
Contributor

Closing in favor of #748.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jonasnick jonasnick jonasnick left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation should provide example callers.
3 participants
@kroggen @real-or-random @jonasnick