Skip to content

Commit a9851bb

Browse files
committed
docs: ✏️ Updated README.md, added setup, testing and deployments
1 parent 0fb25da commit a9851bb

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
1-
# contracts
1+
[![@windingtree/contracts](https://img.shields.io/npm/v/@windingtree/contracts)](https://www.npmjs.com/package/@windingtree/contracts)
2+
[![Beta Release](https://github.com/windingtree/contracts/actions/workflows/release.yml/badge.svg?branch=beta)](https://github.com/windingtree/contracts/actions/workflows/release.yml)
3+
4+
# @windingtree/contracts
25

36
The WindingTree market protocol smart contracts and utilities
7+
8+
## Deployments
9+
10+
### Polygon zkEVM
11+
12+
- Config ([0x098b1d12cAfE7315C77b6d308A62ce02806260Ee](https://explorer.public.zkevm-test.net/address/0x098b1d12cAfE7315C77b6d308A62ce02806260Ee/read-proxy#address-tabs)): the protocol configuration smart contract
13+
- EntitiesRegistry ([0x4bB51528C83844b509E1152EEb05260eE1bf60e6](https://explorer.public.zkevm-test.net/address/0x4bB51528C83844b509E1152EEb05260eE1bf60e6/read-proxy#address-tabs)): the protocol identity management
14+
- Market ([0xDd5B6ffB3585E109ECddec5293e31cdc1e9DeD57](https://explorer.public.zkevm-test.net/address/0xDd5B6ffB3585E109ECddec5293e31cdc1e9DeD57/read-proxy#address-tabs)): the protocol entry point
15+
- LIF ([0xba515AB7FfDa899a2e6c8FDbcDf351c8c15f4009](https://explorer.public.zkevm-test.net/address/0xba515AB7FfDa899a2e6c8FDbcDf351c8c15f4009/read-proxy#address-tabs)): Test version of LIF token
16+
17+
## Install package
18+
19+
```bash
20+
yarn add @windingtree/contracts
21+
```
22+
23+
## Setup
24+
25+
```bash
26+
yarn
27+
yarn build:contracts
28+
```
29+
30+
## Testing
31+
32+
```bash
33+
yarn test:contracts
34+
```
35+
36+
## Contributing
37+
38+
[Contribution guidelines](https://windingtree.github.io/sdk/#/docs/contribution)

0 commit comments

Comments
 (0)