diff --git a/README.md b/README.md index 6023eb4..7200207 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ -[![Build Status](https://travis-ci.org/rust-bitcoin/rust-secp256k1.png?branch=master)](https://travis-ci.org/rust-bitcoin/rust-secp256k1) +
-## rust-secp256k1 +`rust-secp256k1` is a wrapper around [libsecp256k1](https://github.com/bitcoin-core/secp256k1), a C +library implementing various cryptographic functions using the [SECG](https://www.secg.org/) curve +[secp256k1](https://en.bitcoin.it/wiki/Secp256k1). + +This library: -`rust-secp256k1` is a wrapper around [libsecp256k1](https://github.com/bitcoin-core/secp256k1), -a C library by Pieter Wuille for producing ECDSA signatures using the SECG curve -`secp256k1`. This library * exposes type-safe Rust bindings for all `libsecp256k1` functions * implements key generation * implements deterministic nonce generation via RFC6979 diff --git a/secp256k1-sys/README.md b/secp256k1-sys/README.md index 5928b6c..3305e2d 100644 --- a/secp256k1-sys/README.md +++ b/secp256k1-sys/README.md @@ -1,38 +1,51 @@ -secp256k1-sys -============= + -This crate provides Rust definitions for the FFI structures and methods. - +Provides low-level bindings to the C FFI exposed by [libsecp256k1](https://github.com/bitcoin-core/secp256k1). ## Vendoring -The default build process is to build using the vendored libsecp256k1 sources in -the depend folder. These sources are prefixed with a special -rust-secp256k1-sys-specific prefix `rustsecp256k1_v1_2_3_`. +The default build process is to build using the vendored `libsecp256k1` sources in the `depend` +directory. These sources are prefixed with a special rust-secp256k1-sys-specific prefix +`rustsecp256k1_v1_2_3_`. This prefix ensures that no symbol collision can happen: -- when a Rust project has two different versions of rust-secp256k1 in its - depepdency tree, or -- when rust-secp256k1 is used for building a static library in a context where - existing libsecp256k1 symbols are already linked. -To update the vendored sources, use the `vendor-libsecp.sh` script: +- When a Rust project has two different versions of `rust-secp256k1` in its depepdency tree, or +- When `rust-secp256k1` is used for building a static library in a context where existing + `libsecp256k1` symbols are already linked. -``` -$ ./vendor-libsecp.sh