Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
maschad committed Jan 28, 2024
1 parent 44bcfa0 commit 71b2f8d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 6 deletions.
50 changes: 44 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,48 @@
Work in progress...
# Gerrehbenta 🚧

A uniswap cli built in rust to track various info about your positions. Fast access to [uniswap's analytics](https://info.uniswap.org/home)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/maschad/gerrehbenta/blob/main/LICENSE)
![Build Status](https://github.com/maschad/gerrehbenta/actions/workflows/rust.yml/badge.svg)

🚧 **This project is currently under construction!** 🚧

Welcome to Gerrehbenta! This is a work in progress, and I'm actively developing and improving it. Please note that some features may be incomplete or missing, and the project might not yet be ready for production use.

## Table of Contents
- [Gerrehbenta 🚧](#gerrehbenta-)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Features](#features)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)

## About

Gerrehbenta is a uniswap cli built in rust to track info about any wallet's positions. Fast access to [uniswap's analytics](https://info.uniswap.org/home).

## Features

- Search on Tokens, Pairs, Accounts & Transactions
- Track your positions, impermanent loss, fees earned, top pairs by historical and estimated fees
- Total Liquidity, Volume
- Top pairs & tokens by symbol, volume, liquidity, price.
- Search for any wallet address and get a summary of their positions.
- Track your positions, impermanent loss, fees earned, top pairs by historical and estimated fees. and APYs.
- View current volume and fees for specific ranges on any pair.

## Getting Started

To get started with Gerrehbenta, follow these steps:

1. cargo build


## Contributing

We welcome contributions from the community! If you'd like to contribute to Gerrehbenta, please follow these guidelines:

1. [Fork](https://github.com/maschad/gerrehbenta/fork) the repository.
2. Create a new branch for your feature or bugfix: `git checkout -b feature-name`.
3. Make your changes and commit them: `git commit -m 'Add some feature'`.
4. Push to your branch: `git push origin feature-name`.
5. Submit a pull request to the `main` branch of this repository.

## License

This project is licensed under the [MIT License](LICENSE).
2 changes: 2 additions & 0 deletions src/network/server.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
use std::error::Error;

pub async fn queryGQL(url: String, query_type: String) -> Result<(), Box<dyn Error + Send + Sync>> {
unimplemented!()
}

0 comments on commit 71b2f8d

Please sign in to comment.