Skip to content

Commit c9ccd45

Browse files
Will CoryWill Cory
authored andcommitted
documentation
1 parent de4279b commit c9ccd45

1 file changed

Lines changed: 18 additions & 20 deletions

File tree

packages/atst/README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,46 @@
66
</p>
77

88
<p align="center">
9-
I need a tagline here
9+
The official SDK for Optimism's attestation Station
1010
<p>
1111
<a href="https://www.npmjs.com/package/@eth-optimism/atst" target="\_parent">
1212
<img alt="" src="https://img.shields.io/npm/dm/@eth-optimism/atst.svg" />
1313
</a>
1414

1515
# atst
1616

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
1818

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!
2620

2721
## Getting started
2822

2923
Install
3024

3125
```bash
32-
npm install @eth-optimism/atst
26+
npm install @eth-optimism/atst @wagmi/core
3327
```
3428

35-
## ATST SDK
29+
## atst typescript sdk
3630

37-
TODO
31+
The typescript sdk provides a clean [wagmi](https://wagmi.sh/) based interface for reading and writing to the attestation station
3832

39-
## ATST CLI
33+
### See [sdk docs]() for usage instructions
4034

41-
TODO
35+
## atst cli
4236

43-
## Contributing
37+
The cli provides a convenient cli for interacting with the attestation station contract
4438

45-
Please see our [contributing.md](/docs/contributing.md).
39+
TODO put a gif here of using it
4640

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
4846

49-
**This sdk is not yet released**
47+
Please see our [contributing.md](/docs/contributing.md). No contribution is too small.
5048

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
5250

53-
TODO
51+
## Check [Awesome ATST](https://todo.todo.todo) for awesome tools and examples around the attestation station

0 commit comments

Comments
 (0)