Updated documentation

2023-07-23 21:07:52 +02:00
parent 6c8e74bc5f
commit 2c1c113f86
1 changed files with 9 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,11 @@
 # hash

-Hash experiments.
+This is a non-cryptographic hash (aka checksum) to verify data integrity.
+
+## API
+
+```go
+sum := hash.Bytes(data)
+```
+
+You can use `strconv.FormatUint(sum, 16)` to get a string in hexadecimal format.