e8bab6bc19
First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Third, it's modifies the Installation section to Installation and Updating and adds a -u to the go get command since it works for both and thus is simpler. Finally, it replaces the badges with SVG versions from shields.io so they are consistent.
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
base58
|
|
==========
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcutil) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
[]
|
|
(http://godoc.org/github.com/btcsuite/btcutil/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](https://en.bitcoin.it/wiki/Base58Check_encoding).
|
|
|
|
A comprehensive suite of tests is provided to ensure proper functionality.
|
|
|
|
## Installation and Updating
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcutil/base58
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [Decode Example]
|
|
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-Decode)
|
|
Demonstrates how to decode modified base58 encoded data.
|
|
* [Encode Example]
|
|
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-Encode)
|
|
Demonstrates how to encode data using the modified base58 encoding scheme.
|
|
* [CheckDecode Example]
|
|
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckDecode)
|
|
Demonstrates how to decode Base58Check encoded data.
|
|
* [CheckEncode Example]
|
|
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckEncode)
|
|
Demonstrates how to encode data using the Base58Check encoding scheme.
|
|
|
|
## License
|
|
|
|
Package base58 is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|