From 4e83305015e021d18cc01e8fc921e59911c3985a Mon Sep 17 00:00:00 2001 From: sirEven Date: Thu, 7 Nov 2024 11:30:38 +0100 Subject: [PATCH] Update readme. --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e3745c1..bf358a7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+
LoCaSt
Local Candle Store - A module to download price candles from exchanges and store them in a database. @@ -10,13 +10,14 @@ LoCaSt handles candle data in a very straight forward manner: - These clusters are written into an sqlite database and can be updated as needed. ## Cluster -A cluster is a list of candle objects, representing a time series of price data. Per exchange (e.g.: dydx v4), market (e.g.: ETH) and resolution (e.g.: One minute), there can be exactly one cluster in the database. A **cluster** can be interacted with in the following ways. +A **cluster** is a list of candle objects, representing a time series of price data. Per exchange (e.g.: dydx v4), market (e.g.: ETH) and resolution (e.g.: One minute), there can be exactly one **cluster** in the database. A **cluster** can be interacted with in the following ways. ## Currently implemented ### Features - Create cluster - Retrieve cluster +- Retrieve n newest candles of a cluster - Update cluster - Delete cluster - Get info about cluster