Bring README.md up-to-date with the current status.

This commit is contained in:
Dave Collins 2013-12-28 15:04:12 -06:00
parent cc712827da
commit 2d875b39f9

View file

@ -4,14 +4,14 @@ btcec
[![Build Status](https://travis-ci.org/conformal/btcec.png?branch=master)]
(https://travis-ci.org/conformal/btcec)
Package btcec implements elliptic curve cryptography using koblitz curves
(secp256k1 only for now). It is designed so that it may be used with the
standard crypto/ecdsa packages provided with go. There is a test suite
which is aiming to reach 100% code coverage. See `test_coverage.txt`
for the current coverage (using gocov). On a UNIX-like OS, the script
`cov_report.sh` can be used to generate the report. Package btcec uses
work from ThePiachu which is licensed under the same terms as Go. The
Conformal original is licensed under the liberal ISC license.
Package btcec implements elliptic curve cryptography needed for working with
Bitcoin (secp256k1 only for now). It is designed so that it may be used with the
standard crypto/ecdsa packages provided with go. There is a test suite which
provides extensive coverage. See `test_coverage.txt` for the current coverage
(using gocov). On a UNIX-like OS, the script `cov_report.sh` can be used to
generate the report. Package btcec uses work from ThePiachu which is licensed
under the same terms as Go. The Conformal original is licensed under the
liberal ISC license.
This package is one of the core packages from btcd, an alternative full-node
implementation of bitcoin which is under active development by Conformal.
@ -47,10 +47,6 @@ http://localhost:6060/pkg/github.com/conformal/btcec
$ go get github.com/conformal/btcec
```
## TODO
- Increase test coverage to 100%
## GPG Verification Key
All official release tags are signed by Conformal so users can ensure the code