瀏覽代碼

add readme for each package

Aneurin Barker Snook 11 月之前
父節點
當前提交
0aed2fb5d8
共有 2 個文件被更改,包括 36 次插入10 次删除
  1. 34 0
      README.md
  2. 2 10
      hash.go

+ 34 - 0
README.md

@@ -0,0 +1,34 @@
+# Go Hash
+
+Simple wrapper functions which take arbitrary string input and return string hashes in hex encoding.
+
+The author is aware that this package is somewhat perfunctory, but likes not having to think about the `crypto` packages.
+
+## Example
+
+```go
+package main
+
+import (
+	"errors"
+	"fmt"
+	"os"
+
+	"github.com/annybs/go/hash"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		fmt.Println(errors.New("input required"))
+		os.Exit(1)
+	}
+
+	fmt.Println(hash.SHA256(os.Args[1]))
+}
+```
+
+Execute `go run main.go "any test string you like"` to create SHA256 output.
+
+## License
+
+See [LICENSE.md](../LICENSE.md)

+ 2 - 10
hash.go

@@ -9,19 +9,11 @@ import (
 // SHA256 creates a hex-encoded SHA256 checksum for a string input.
 func SHA256(value string) string {
 	sum := sha256.Sum256([]byte(value))
-	hash := []byte{}
-	for _, b := range sum {
-		hash = append(hash, b)
-	}
-	return hex.EncodeToString(hash)
+	return hex.EncodeToString(sum[0:])
 }
 
 // SHA512 creates a hex-encoded SHA512 checksum for a string input.
 func SHA512(value string) string {
 	sum := sha512.Sum512([]byte(value))
-	hash := []byte{}
-	for _, b := range sum {
-		hash = append(hash, b)
-	}
-	return hex.EncodeToString(hash)
+	return hex.EncodeToString(sum[0:])
 }