From 2c1c113f86b3b639bdab4efbbed3842b46afb0e3 Mon Sep 17 00:00:00 2001 From: Eduard Urbach Date: Sun, 23 Jul 2023 21:07:52 +0200 Subject: [PATCH] Updated documentation --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 375e107..5d7ee90 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # hash -Hash experiments. \ No newline at end of file +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. \ No newline at end of file