Merge pull request #1382 from o1-labs/hashing-example-readme

Create README.md for SHA-256 hashing example
o1-labs · Jan 31, 2024 · fdda49c · fdda49c
2 parents c19ea70 + cc0e391
commit fdda49c
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/examples/zkapps/hashing/README.md b/src/examples/zkapps/hashing/README.md
@@ -0,0 +1,5 @@
+Hash functions under the `Hash` namespace in o1js require binary arithmetic and operate over binary data. 
+
+This example shows how to extend the `Bytes` class and specify the length of bytes.
+
+See the [Keccak](https://docs.minaprotocol.com/zkapps/o1js/keccak) and [SHA-256](https://docs.minaprotocol.com/zkapps/o1js/sha256) documentation for o1js.