status-im
/
secp256k1.swift
mirror of https://github.com/status-im/secp256k1.swift.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add usage to README

This commit is contained in:
Koray Koska 2018-02-16 14:05:26 +01:00
parent f4d966f03f
commit 3ed446c78f
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -33,7 +33,7 @@ All credits for the original source code goes to [bitcoin-core](https://github.c
## Example
To run the example project, run `pod try secp256k1`. Or clone the repo, and run pod install from the Example directory.
To run the example project, run `pod try secp256k1.swift`. Or clone the repo, and run pod install from the Example directory.
## Installation
@ -41,9 +41,19 @@ secp256k1 is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your `Podfile`:
```ruby
pod 'secp256k1'
pod 'secp256k1.swift'
```
## Usage
To use secp256k1 functions you need to import it first.
```Swift
import secp256k1
```
After that you can use all secp256k1 functions as described [in the official headers](https://github.com/bitcoin-core/secp256k1/tree/master/include).
## Author
Koray Koska, koray@koska.at