diff --git a/README.md b/README.md index 24b9fe6..903ea69 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,44 @@ -# secp256k1 + + + -[![CI Status](http://img.shields.io/travis/Boilertalk/secp256k1.swift.svg?style=flat)](https://travis-ci.org/Boilertalk/secp256k1.swift) -[![Version](https://img.shields.io/cocoapods/v/secp256k1.svg?style=flat)](http://cocoapods.org/pods/secp256k1) -[![License](https://img.shields.io/cocoapods/l/secp256k1.svg?style=flat)](http://cocoapods.org/pods/secp256k1) -[![Platform](https://img.shields.io/cocoapods/p/secp256k1.svg?style=flat)](http://cocoapods.org/pods/secp256k1) +

+ + CI Status + + + Version + + + License + + + Platform + + + Carthage compatible + +

+ +# :alembic: secp256k1 + +This library provides [secp256k1](https://github.com/bitcoin-core/secp256k1) bindings for Swift with Cocoapods, Carthage and Swift Package Manager on macOS and Linux. +The Cocoapods version supports iOS 8.0, macOS 10.10, tvOS 9.0 and watchOS 2.0. The Swift Package Manager version supports macOS and Linux. + +We try to merge bug fix commits ASAP and only change the import and config structure of the original repository in order to create a compilable version for the package managers. + +All credits for the original source code goes to [bitcoin-core](https://github.com/bitcoin-core). + +> Note: This library only binds the original C code into a Swift package. If you want an Ethereum Web3 package which manages signatures and verifications, check out [Web3.swift](https://github.com/Boilertalk/Web3.swift) ## Example -To run the example project, clone the repo, and run `pod install` from the Example directory first. - -## Requirements +To run the example project, run `pod try secp256k1`. Or clone the repo, and run pod install from the Example directory. ## Installation secp256k1 is available through [CocoaPods](http://cocoapods.org). To install -it, simply add the following line to your Podfile: +it, simply add the following line to your `Podfile`: ```ruby pod 'secp256k1'