diff --git a/README.md b/README.md new file mode 100644 index 0000000..d1901b1 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +[![Go](https://github.com/dineshpinto/geckoterminal-go/actions/workflows/go.yml/badge.svg)](https://github.com/dineshpinto/geckoterminal-go/actions/workflows/go.yml) + +# GeckoTerminal Go + +## RESTful Go Client for GeckoTerminal API + +Wrapper around the [GeckoTerminal](https://www.geckoterminal.com) DeFi and DeX +aggregator operating across 90+ chains and 500+ dexes. +Features both synchronous and asynchronous APIs. + +Features: + +- Get the market data (price, volume, historical chart) of any token +- Find all the pools that are trading a specific token +- Plot a candlestick chart using OHLCV when given a pool address + +The API is currently in beta and is subject to change, please report any issues you +find. + +## Installation + +```bash +go install github.com/dineshpinto/geckoterminal-go +```