Skip to content

Commit

Permalink
Doc: refine the README of the project
Browse files Browse the repository at this point in the history
  • Loading branch information
lykimq committed Jan 22, 2024
1 parent fc77896 commit 216a15d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 216a15d

Please sign in to comment.