nim-secp256k1/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2018-09-05 05:05:11 +00:00
# secp256k1
2018-05-27 21:26:12 +00:00
2018-03-30 09:33:32 +00:00
[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2018-09-05 05:05:11 +00:00
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)
![Github action](https://github.com/status-im/nim-secp256k1/workflows/CI/badge.svg)
2018-03-30 09:33:32 +00:00
2018-05-27 21:26:27 +00:00
# Introduction
2020-04-17 05:43:30 +00:00
This library is a wrapper for Bitcoin's [secp256k1](https://github.com/bitcoin-core/secp256k1) library. Two interfaces are exposed - `secp256k1` which thinly wraps the raw C interface found in `secp256k1_abi`. The thin wrapper is recommended.
2018-05-27 21:26:12 +00:00
# Installation
2018-06-17 08:23:36 +00:00
2018-06-17 20:10:21 +00:00
Add to your `.nimble` file:
```
requires "secp256k1"
```
# Build and test
2018-06-17 08:23:36 +00:00
```
# Upstream secp256k1 c library is tracked with a submodule
git submodule update --init
2018-06-17 20:10:21 +00:00
nimble test
2018-06-17 08:23:36 +00:00
```
2019-01-02 14:00:18 +00:00
2018-09-05 05:05:11 +00:00
## License
2018-06-17 08:23:36 +00:00
2018-09-05 18:48:35 +00:00
Licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
2019-01-02 14:00:18 +00:00
or
2018-09-05 05:05:11 +00:00
2019-01-02 14:00:18 +00:00
* Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
at your option. This file may not be copied, modified, or distributed except according to those terms.