Skip to content

Commit

Permalink
docs: replace "Getting Started" with pointer to maintained docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dckc committed Jan 5, 2024
1 parent 60d8c32 commit 7dd7d1e
Showing 1 changed file with 9 additions and 31 deletions.
40 changes: 9 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,41 +6,19 @@ This is a simple app for the [Agoric smart contract platform](https://docs.agori
style="border: 1px solid" width="300"
src="https://docs.agoric.com/assets/img/new_002_small2.2dfb7462.png" />

The contract lets you give a small amount of [IST](https://inter.trade/) in exchange for
a few NFTs that represent places in a hypothetical game.

The UI is a React app started with the [vite](https://vitejs.dev/) `react-ts` template.
On top of that, we add

- Watching [blockchain state queries](https://docs.agoric.com/guides/getting-started/contract-rpc.html#querying-vstorage)
- [Signing and sending offers](https://docs.agoric.com/guides/getting-started/contract-rpc.html#signing-and-broadcasting-offers)
The contract lets you make an offer to give a small amount of [IST](https://inter.trade/) in exchange for
a few NFTs.

## Getting started

First get set up with [README-local-chain](./README-local-chain.md).

The deploy the contract:

```sh
yarn start:contract
```
See [Your First Agoric Dapp](https://docs.agoric.com/guides/getting-started/) tutorial.

Use the key material to set up an account in Keplr.
## Contributing: Development, Testing

Start the UI:

```sh
cd ui
yarn
yarn dev
```

Then hit **Connect Wallet**. The UI should show your address.

Then **Make Offer**. Keplr should show an offer to **give** 0.25 IST
and **want** a few places. Sign and broadcast the offer.
After a few seconds, the UI should show the places.
The UI is a React app started with the [vite](https://vitejs.dev/) `react-ts` template.
On top of that, we add

## Testing, Development
- Watching [blockchain state queries](https://docs.agoric.com/guides/getting-started/contract-rpc.html#querying-vstorage)
- [Signing and sending offers](https://docs.agoric.com/guides/getting-started/contract-rpc.html#signing-and-broadcasting-offers)

See [CONTRIBUTING](./CONTRIBUTING.md).
See [CONTRIBUTING](./CONTRIBUTING.md) for more on testing.

0 comments on commit 7dd7d1e

Please sign in to comment.