|
6 | 6 | </p> |
7 | 7 |
|
8 | 8 | <p align="center"> |
9 | | - I need a tagline here |
| 9 | + The official SDK for Optimism's attestation Station |
10 | 10 | <p> |
11 | 11 | <a href="https://www.npmjs.com/package/@eth-optimism/atst" target="\_parent"> |
12 | 12 | <img alt="" src="https://img.shields.io/npm/dm/@eth-optimism/atst.svg" /> |
13 | 13 | </a> |
14 | 14 |
|
15 | 15 | # atst |
16 | 16 |
|
17 | | -atst is a typescript sdk and cli around the attestation station (TODO link to attstation station) |
| 17 | +atst is a typescript sdk and cli around the attestation station |
18 | 18 |
|
19 | | -Maybe put a gif of the cli here? |
20 | | - |
21 | | -## Visit [Docs](https://evmts-docs-fx6udvub5-evmts.vercel.app/en/getting-started) for more documentation on teh attestation station! |
22 | | - |
23 | | -TODO link to oris docs here |
24 | | - |
25 | | -Maybe link to cli docs and sdk docs seperately? |
| 19 | +### Visit [Docs](https://community.optimism.io/docs/governance/attestation-station/) for general documentation on the attestation station! |
26 | 20 |
|
27 | 21 | ## Getting started |
28 | 22 |
|
29 | 23 | Install |
30 | 24 |
|
31 | 25 | ```bash |
32 | | -npm install @eth-optimism/atst |
| 26 | +npm install @eth-optimism/atst @wagmi/core |
33 | 27 | ``` |
34 | 28 |
|
35 | | -## ATST SDK |
| 29 | +## atst typescript sdk |
36 | 30 |
|
37 | | -TODO |
| 31 | +The typescript sdk provides a clean [wagmi](https://wagmi.sh/) based interface for reading and writing to the attestation station |
38 | 32 |
|
39 | | -## ATST CLI |
| 33 | +### See [sdk docs]() for usage instructions |
40 | 34 |
|
41 | | -TODO |
| 35 | +## atst cli |
42 | 36 |
|
43 | | -## Contributing |
| 37 | +The cli provides a convenient cli for interacting with the attestation station contract |
44 | 38 |
|
45 | | -Please see our [contributing.md](/docs/contributing.md). |
| 39 | +TODO put a gif here of using it |
46 | 40 |
|
47 | | -## 🚧 WARNING: UNDER CONSTRUCTION 🚧 |
| 41 | +## React instructions |
| 42 | + |
| 43 | +For react hooks we recomend using the [wagmi cli](https://wagmi.sh/cli/getting-started) with the [etherscan plugin](https://wagmi.sh/cli/plugins/etherscan) and [react plugin](https://wagmi.sh/cli/plugins/react) to automatically generate react hooks around the attestation station. See [example/react](http://todo.todo.todo) for an example |
| 44 | + |
| 45 | +## Contributing |
48 | 46 |
|
49 | | -**This sdk is not yet released** |
| 47 | +Please see our [contributing.md](/docs/contributing.md). No contribution is too small. |
50 | 48 |
|
51 | | -## Check out these other awesome attestation station tools |
| 49 | +Having your contribution denied feels bad. Please consider opening an issue before adding any new features or apis |
52 | 50 |
|
53 | | -TODO |
| 51 | +## Check [Awesome ATST](https://todo.todo.todo) for awesome tools and examples around the attestation station |
0 commit comments