update README

algorandfoundation · Jun 19, 2024 · 8f3c4e2 · 8f3c4e2
1 parent da6cba1
commit 8f3c4e2
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/reference_contract/README.md b/reference_contract/README.md
@@ -0,0 +1,15 @@
+# Reference Contract
+
+This is the reference implementation of the contract that will be used to store the DIDDocuments for `did:algo`. This is the contract that is used by the CLI tool by default when deploying a new contract.
+
+It should be noted that the `did:algo` spec will work with any contract that implements the ABI interface defined in [the ARC4 JSON description](./contracts/artifacts/AlgoDID.arc4.json) and the `did:algo` [spec](../SPEC.md).
+
+## Tests
+
+Tests for the contract can be found at [here](./__test__/algo-did.test.ts).
+
+## Interacting With Contract
+
+Golang code for interacting with this contract can be seen [here](../client/internal/main.go).
+
+TypeScript code for interacting with this contract can be seen [here](./src/index.ts).