Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
sirEven committed Nov 7, 2024
1 parent 32fc7f3 commit 4e83305
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div align="center"><img src="icons/halloween_3@3x.png" alt="" width="200"></td></div>
<div align="center"><img src="icons/fancy_transparent@3x.png" alt="" width="200"></td></div>
<b><center>LoCaSt</center></b>

Local Candle Store - A module to download price candles from exchanges and store them in a database.
Expand All @@ -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
Expand Down

0 comments on commit 4e83305

Please sign in to comment.