History

Dave Collins e47deda418 docs: Make various README.md files consistent. Contains the following upstream commits: - `5fd45e8085` - Reverted because txsort needs a decred-specific spec - `98fd0a0661` - Reverted because txsort needs a decred-specific spec - `e0e9257790` - Reverted because txsort needs a decred-specific spec - `0df67ee064` - Reverted because txsort needs a decred-specific spec - `d6989ebc71` - Reverted because txsort needs a decred-specific spec - `e8bab6bc19` As noted, the merge commit reverts all of the txsort-related commits in between. It also modifies the paths in the README updates to decred-specific paths.		2016-11-15 13:02:05 -06:00
..
alphabet.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
base58_test.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
base58.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
base58bench_test.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
base58check_test.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
base58check.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
cov_report.sh	Create a new sub-package base58.	2014-12-22 11:43:07 +01:00
doc.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
example_test.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
genalphabet.go	Initial Decred Commit.	2016-02-07 13:54:36 -05:00
README.md	docs: Make various README.md files consistent.	2016-11-15 13:02:05 -06:00

README.md

base58

[] (https://travis-ci.org/decred/dcrutil) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [] (http://godoc.org/github.com/decred/dcrutil/base58)

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.

Installation and Updating

$ go get -u github.com/decred/dcrutil/base58

Examples

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

License

Package base58 is licensed under the copyfree ISC License.