diff --git a/README.md b/README.md index c0067ec4..fc524685 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,14 @@ ZetaChain is a public, decentralized blockchain and smart contract platform buil yarn compile +### Packages + +#### [Addresses](packages/addresses) + +#### [Example contracts](packages/example-contracts) + +#### [Protocol contracts](packages/example-contracts) + ### Cross-repo commands #### Package-specific commands diff --git a/packages/addresses/README.md b/packages/addresses/README.md new file mode 100644 index 00000000..542c3f7e --- /dev/null +++ b/packages/addresses/README.md @@ -0,0 +1,3 @@ +# ZetaChain addresses + +This package includes utilities to work with multiple addresses and networks. diff --git a/packages/example-contracts/README.md b/packages/example-contracts/README.md index 50ced2fe..f14c08bb 100644 --- a/packages/example-contracts/README.md +++ b/packages/example-contracts/README.md @@ -1,5 +1,7 @@ # ZetaChain example contracts +> ⚠️ The contracts **are not audited yet**, use at your own risk. + ## Environment variables Follow the template in `.env.example`.