Skip to content

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

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

Closed
wants to merge 1 commit into from
Closed

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,11 @@ Exhaustive tests
With valgrind, you might need to increase the max stack size:

$ valgrind --max-stackframe=2500000 ./exhaustive_tests


Usage
-----

* The application must generate the private key with a strong random number generator and check its validity with the `secp256k1_ec_seckey_verify` function
* The private key is stored separately from the context and your app is responsible for storing and loading it
* The application can generate the public key using the `secp256k1_ec_pubkey_create` and `secp256k1_ec_pubkey_serialize` functions (check [src/bench_verify.c](src/bench_verify.c))