diff --git a/README.md b/README.md index 0892a1f..2030c48 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Tezos Gas Station library -This library helps you -- use [Marigold's Gas Station API](https://github.com/marigold-dev/gas-station) in TypeScript -- create [TZIP-17 permit contracts](https://tzip.tezosagora.org/proposal/tzip-17/), which are FA2 - contracts that can be manipulated by a 3rd party (such as the gas station API). Permits are signed +This library facilitates the following: +- Utilizing [Marigold's Gas Station API](https://github.com/marigold-dev/gas-station) in TypeScript. +- Creating [TZIP-17 permit contracts](https://tzip.tezosagora.org/proposal/tzip-17/), which are FA2 + contracts capable of being manipulated by a 3rd party, such as the gas station API. Permits are signed off-chain and can be posted and executed by anyone. -A toy webapp example is available in the `examples/` directory. +An example of a toy web app is provided in the `examples/nft` directory. -Contributions welcome at https://github.com/marigold-dev/gas-station-lib. +Feel free to contribute and provide feedback on https://github.com/marigold-dev/gas-station-lib.