LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity

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

Browse source
This commit is contained in:
Dave Collins 2013-12-28 15:04:12 -06:00
parent cc712827da
commit 2d875b39f9
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

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