Merge pull request #201 from Bytom/v0.1

[bytom/vapor.git] / vendor / github.com / mr-tron / base58 / README.md

diff --git a/vendor/github.com/mr-tron/base58/README.md b/vendor/github.com/mr-tron/base58/README.md
deleted file mode 100644 (file)
index 98b2fa2..0000000
--- a/vendor/github.com/mr-tron/base58/README.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Fast Implementation of Base58 encoding
-[![GoDoc](https://godoc.org/github.com/mr-tron/base58?status.svg)](https://godoc.org/github.com/mr-tron/base58)  [![Go Report Card](https://goreportcard.com/badge/github.com/mr-tron/base58)](https://goreportcard.com/report/github.com/mr-tron/base58)
-[![Used By](https://sourcegraph.com/github.com/mr-tron/base58/base58/-/badge.svg)](https://sourcegraph.com/github.com/mr-tron/base58?badge)
-
-Fast implementation of base58 encoding in Go. 
-
-Base algorithm is copied from https://github.com/trezor/trezor-crypto/blob/master/base58.c
-
-## Benchmark
-Trivial - encoding via big.Int (over libraries use this implemenation)
-Fast - optimized algorythm from trezor
-
-```
-BenchmarkTrivialBase58Encoding-4         200000             10602 ns/op  
-BenchmarkFastBase58Encoding-4           1000000              1637 ns/op
-BenchmarkTrivialBase58Decoding-4         200000              8316 ns/op
-BenchmarkFastBase58Decoding-4           1000000              1045 ns/op
-```
-Encoding - **faster by 6 times**
-
-Decoding - **faster by 8 times**
-
-## Usage example
-
-```go
-
-package main
-
-import (
-       "fmt"
-       "github.com/mr-tron/base58"
-)
-
-func main() {
-
-       encoded := "1QCaxc8hutpdZ62iKZsn1TCG3nh7uPZojq"
-       num, err := base58.Decode(encoded)
-       if err != nil {
-               fmt.Printf("Demo %v, got error %s\n", encoded, err)     
-       }
-       chk := base58.Encode(num)
-       if encoded == string(chk) {
-               fmt.Printf ( "Successfully decoded then re-encoded %s\n", encoded )
-       } 
-}
-
-```