README.adoc raw

   1  = bech32
   2  
   3  image:http://img.shields.io/badge/license-ISC-blue.svg[ISC License,link=http://copyfree.org]
   4  image:https://godoc.org/realy.lol/pkg/ec/bech32?status.png[GoDoc,link=http://godoc.org/realy.lol/pkg/ec/bech32]
   5  
   6  Package bech32 provides a Go implementation of the bech32 format specified in
   7  https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki[BIP 173].
   8  
   9  Test vectors from BIP 173 are added to ensure compatibility with the BIP.
  10  
  11  == Installation and Updating
  12  
  13  [source,bash]
  14  ----
  15  $ go get -u mleku.dev/pkg/ec/bech32
  16  ----
  17  
  18  == Examples
  19  
  20  * http://godoc.org/realy.lol/pkg/ec/bech32#example-Bech32Decode[Bech32 decode Example]
  21  Demonstrates how to decode a bech32 encoded string.
  22  * http://godoc.org/realy.lol/pkg/ec/bech32#example-BechEncode[Bech32 encode Example]
  23  Demonstrates how to encode data into a bech32 string.
  24  
  25  == License
  26  
  27  Package bech32 is licensed under the http://copyfree.org[copyfree] ISC License.