nim-secp256k1/README.md

# secp256k1

[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![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)

# Introduction

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.

# Installation

Add to your `.nimble` file:
```
requires "secp256k1"
```

# Build and test

```
# Upstream secp256k1 c library is tracked with a submodule
git submodule update --init
nimble test
```

## License

Licensed and distributed under either of

* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT

or

* 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.
ci: update readme: fix license, badges 2018-09-04 23:05:11 -06:00			`# secp256k1`
Update README.md 2018-05-27 14:26:12 -07:00
Add badges to README 2018-03-30 11:33:32 +02:00			`[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
ci: update readme: fix license, badges 2018-09-04 23:05:11 -06: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)`
CI: refactor Nim compiler caching (#33) 2021-06-03 02:08:23 +02:00			`![Github action](https://github.com/status-im/nim-secp256k1/workflows/CI/badge.svg)`
Add badges to README 2018-03-30 11:33:32 +02:00
Update README.md 2018-05-27 14:26:27 -07:00			`# Introduction`
add convenience api (#21) fixes #19 2020-04-17 07:43:30 +02: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.
Update README.md 2018-05-27 14:26:12 -07:00
			`# Installation`
add submodule init to install docs 2018-06-17 10:23:36 +02:00
split build and install instructions 2018-06-17 22:10:21 +02:00			Add to your `.nimble` file:
			```
			`requires "secp256k1"`
			```

			`# Build and test`

add submodule init to install docs 2018-06-17 10:23:36 +02:00			```
			`# Upstream secp256k1 c library is tracked with a submodule`
			`git submodule update --init`
split build and install instructions 2018-06-17 22:10:21 +02:00			`nimble test`
add submodule init to install docs 2018-06-17 10:23:36 +02:00			```
Update README.md 2019-01-02 15:00:18 +01:00
ci: update readme: fix license, badges 2018-09-04 23:05:11 -06:00			`## License`
add submodule init to install docs 2018-06-17 10:23:36 +02:00
readme: update license 2018-09-05 12:48:35 -06:00			`Licensed and distributed under either of`

			`* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT`

Update README.md 2019-01-02 15:00:18 +01:00			`or`
ci: update readme: fix license, badges 2018-09-04 23:05:11 -06:00
Update README.md 2019-01-02 15:00:18 +01: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.`