From 42e03432e6be7f0bf18c7f86130d3930bdf4038d Mon Sep 17 00:00:00 2001 From: Elichai Turkel Date: Thu, 30 Apr 2020 15:08:50 +0300 Subject: [PATCH] Add usage examples to the readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5fc07dd4f..f1ae215c8 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,14 @@ libsecp256k1 is built using autotools: $ make check # run the test suite $ sudo make install # optional +Usage examples +----------- + Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`. + For experimental modules, you will also need `--enable-experimental` as well as a flag for each individual module, e.g. `--enable-module-ecdh`. + * [ECDSA example](examples/ecdsa.c) + * [Schnorr Signatures example](examples/schnorr.c) + * [Deriving a shared secret(ECDH) example](examples/ecdh.c) + Test coverage -----------