From 8c6eda087e3ce1881218a4f466da15d481b12614 Mon Sep 17 00:00:00 2001 From: null Date: Thu, 29 Feb 2024 10:57:10 +0000 Subject: [PATCH] =?UTF-8?q?README.md=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..83e8895 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# FinFree Bybit Ticker + +The FinFree Bybit Ticker is a project designed to dynamically watch for changes in a RethinkDB database and subscribe to Bybit's tickers for all symbols that meet a specified condition. It also updates actions based on certain conditions being met. + +## Features + +- **Dynamic Subscription**: Automatically subscribes to Bybit ticker updates for symbols specified in the RethinkDB. +- **Real-time Database Watching**: Utilizes RethinkDB's changefeeds feature to watch for any additions, deletions, or modifications in the symbol list. +- **Conditional Logic**: Implements custom logic to perform actions when specific conditions are met, based on the incoming ticker information. +- **Efficient Updates**: Only subscribes to and acts upon symbols that meet predefined conditions, ensuring efficient use of resources. + +## Requirements + +- RethinkDB +- Python 3.x +- `pybit` WebSocket Client for Bybit +- `rethinkdb` Python Client + +## Installation + +1. **Clone the repository**: + + ```bash + git clone https://github.com/yourusername/finfree-bybit-ticker.git + cd finfree-bybit-ticker