Commit c9ccd45d authored by Will Cory's avatar Will Cory

documentation

parent de4279b2
......@@ -6,7 +6,7 @@
</p>
<p align="center">
I need a tagline here
The official SDK for Optimism's attestation Station
<p>
<a href="https://www.npmjs.com/package/@eth-optimism/atst" target="\_parent">
<img alt="" src="https://img.shields.io/npm/dm/@eth-optimism/atst.svg" />
......@@ -14,40 +14,38 @@
# atst
atst is a typescript sdk and cli around the attestation station (TODO link to attstation station)
atst is a typescript sdk and cli around the attestation station
Maybe put a gif of the cli here?
## Visit [Docs](https://evmts-docs-fx6udvub5-evmts.vercel.app/en/getting-started) for more documentation on teh attestation station!
TODO link to oris docs here
Maybe link to cli docs and sdk docs seperately?
### Visit [Docs](https://community.optimism.io/docs/governance/attestation-station/) for general documentation on the attestation station!
## Getting started
Install
```bash
npm install @eth-optimism/atst
npm install @eth-optimism/atst @wagmi/core
```
## ATST SDK
## atst typescript sdk
TODO
The typescript sdk provides a clean [wagmi](https://wagmi.sh/) based interface for reading and writing to the attestation station
## ATST CLI
### See [sdk docs]() for usage instructions
TODO
## atst cli
## Contributing
The cli provides a convenient cli for interacting with the attestation station contract
Please see our [contributing.md](/docs/contributing.md).
TODO put a gif here of using it
## 🚧 WARNING: UNDER CONSTRUCTION 🚧
## React instructions
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
## Contributing
**This sdk is not yet released**
Please see our [contributing.md](/docs/contributing.md). No contribution is too small.
## Check out these other awesome attestation station tools
Having your contribution denied feels bad. Please consider opening an issue before adding any new features or apis
TODO
\ No newline at end of file
## Check [Awesome ATST](https://todo.todo.todo) for awesome tools and examples around the attestation station
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment