lbcutil/base58/README.md
Dave Collins a630ef8247 A few minor modifications to new base58 package.
- Call out in README.md that this is modified base58 (it's not the same as
  normal base58)
- Remove the blurb about test_coverage.txt since it is no longer needed
  now that the repo now has coveralls integrated
- Rename base58_check[_test].go -> basecheck[_test].go.  Since Go treats
  _<ext> special in some cases like for tests and conditional OS and
  architecture compilation, it's a good idea to avoid naming files with
  them to ensure a new special meaning doesn't break builds in the future
2014-12-22 10:29:07 -06:00

1.2 KiB

base58

[Build Status] (https://travis-ci.org/conformal/btcutil)

Package base58 provides an API for for encoding and decoding to and from the modified base58 encoding. It also provides an API to do base58Check encoding, as described here.

A comprehensive suite of tests is provided to ensure proper functionality. Package base58 is licensed under the copyfree ISC license.

Documentation

[GoDoc] (http://godoc.org/github.com/conformal/btcutil/base58)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/conformal/btcutil/base58

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/conformal/btcutil/base58

Installation

$ go get github.com/conformal/btcutil/base58

License

Package base58 is licensed under the copyfree ISC License.