LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
lbcutil/base58/README.md

41 lines
1.5 KiB
Markdown
Raw Normal View History

Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
base58
==========
docs: Make various README.md files consistent. 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.
2015-10-24 00:10:35 +02:00
[![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)]
(https://travis-ci.org/btcsuite/btcutil) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcutil/base58?status.png)]
(http://godoc.org/github.com/btcsuite/btcutil/base58)
Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
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 19:36:34 +01:00
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,
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 17:23:38 +01:00
as described [here](https://en.bitcoin.it/wiki/Base58Check_encoding).
Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
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 17:23:38 +01:00
A comprehensive suite of tests is provided to ensure proper functionality.
Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
docs: Make various README.md files consistent. 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.
2015-10-24 00:10:35 +02:00
## Installation and Updating
Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
```bash
docs: Make various README.md files consistent. 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.
2015-10-24 00:10:35 +02:00
$ go get -u github.com/btcsuite/btcutil/base58
Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
```
Add testable examples for base58 package. This commit creates and an example test file for the baes58 package that integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code.
2014-12-22 18:26:02 +01:00
## Examples
* [Decode Example]
Update btcutil import paths in README.md files.
2015-01-16 04:35:16 +01:00
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-Decode)
Add testable examples for base58 package. This commit creates and an example test file for the baes58 package that integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code.
2014-12-22 18:26:02 +01:00
Demonstrates how to decode modified base58 encoded data.
* [Encode Example]
Update btcutil import paths in README.md files.
2015-01-16 04:35:16 +01:00
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-Encode)
Add testable examples for base58 package. This commit creates and an example test file for the baes58 package that integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code.
2014-12-22 18:26:02 +01:00
Demonstrates how to encode data using the modified base58 encoding scheme.
* [CheckDecode Example]
Update btcutil import paths in README.md files.
2015-01-16 04:35:16 +01:00
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckDecode)
Add testable examples for base58 package. This commit creates and an example test file for the baes58 package that integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code.
2014-12-22 18:26:02 +01:00
Demonstrates how to decode Base58Check encoded data.
* [CheckEncode Example]
Update btcutil import paths in README.md files.
2015-01-16 04:35:16 +01:00
(http://godoc.org/github.com/btcsuite/btcutil/base58#example-CheckEncode)
Add testable examples for base58 package. This commit creates and an example test file for the baes58 package that integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code.
2014-12-22 18:26:02 +01:00
Demonstrates how to encode data using the Base58Check encoding scheme.
Create a new sub-package base58. It consists of the previous base58 implementation and new base58 check encoding/decoding functions.
2014-12-19 13:40:50 +01:00
## License
Package base58 is licensed under the [copyfree](http://copyfree.org) ISC
License.
Reference in a new issue Copy permalink