add doc.go

mr-tron · Nov 21, 2019 · b1dd383 · b1dd383
1 parent d504ab2
commit b1dd383
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/doc.go b/doc.go
@@ -0,0 +1,21 @@
+/*
+Package base58 provides fast implementation of base58 encoding.
+
+Base58 Usage
+
+To decode a base58 string:
+
+	encoded := "1QCaxc8hutpdZ62iKZsn1TCG3nh7uPZojq"
+	buf, _ := base58.Decode(encoded)
+
+To encode the same data:
+
+	encoded := base58.Encode(buf)
+ 
+With custom alphabet
+
+  customAlphabet := base58.NewAlphabet("123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz")
+  encoded := base58.EncodeAlphabet(buf, customAlphabet)
+  
+*/
+package base58