History

Dave Collins 97fea16721 Add package documentation for base58 package. This commit adds a doc.go file in the base58 package which provides package documentation for godoc.		2014-12-22 12:36:34 -06:00
..
base58.go	Create a new sub-package base58.	2014-12-22 11:43:07 +01:00
base58_test.go	Complete base58 migration to new package.	2014-12-22 10:56:00 -06:00
base58bench_test.go	Add benchmarks to base58 package.	2014-12-22 10:45:21 -06:00
base58check.go	A few minor modifications to new base58 package.	2014-12-22 10:29:07 -06:00
base58check_test.go	A few minor modifications to new base58 package.	2014-12-22 10:29:07 -06:00
cov_report.sh	Create a new sub-package base58.	2014-12-22 11:43:07 +01:00
doc.go	Add package documentation for base58 package.	2014-12-22 12:36:34 -06:00
example_test.go	Add testable examples for base58 package.	2014-12-22 11:58:06 -06:00
README.md	Add package documentation for base58 package.	2014-12-22 12:36:34 -06:00

README.md

base58

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

Package base58 provides an API 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

[] (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

Examples

[Decode Example] (http://godoc.org/github.com/conformal/btcutil/base58#example-Decode)
Demonstrates how to decode modified base58 encoded data.
[Encode Example] (http://godoc.org/github.com/conformal/btcutil/base58#example-Encode)
Demonstrates how to encode data using the modified base58 encoding scheme.
[CheckDecode Example] (http://godoc.org/github.com/conformal/btcutil/base58#example-CheckDecode)
Demonstrates how to decode Base58Check encoded data.
[CheckEncode Example] (http://godoc.org/github.com/conformal/btcutil/base58#example-CheckEncode)
Demonstrates how to encode data using the Base58Check encoding scheme.

License

Package base58 is licensed under the copyfree ISC License.