Update readme.

README.md

@@ -1 +1,29 @@
-LoCaSt: Local Candle Store - A module to download and store price candles from exchanges in a database.
+[alt text]([email protected])!
+LoCaSt: Local Candle Store - A module to download and store price candles from exchanges in a database.
+
+# Intro
+LoCaSt handles candle data in a very straight forward manner: 
+- there is one underlying `Candle` type to hold the relevant data of a price candle
+- a group of such `Candle` objects is collected into a **cluster**, which is simply a `List[Candle]`
+- these clusters are written into an sqlite database an can be updated as needed
+
+### Cluster
+A cluster is a list of candle objects, representing a time series of price data. Per exchange, market and resolution, there can be exactly one cluster in the database. It can be interacted with in the following ways.
+
+### Currently implemented
+
+#### Features
+- create cluster
+- retrieve cluster 
+- update cluster 
+- delete cluster
+- get info about cluster
+    - head
+    - tail 
+    - amount of candles
+    - wether it is up to date
+- ... more to come
+
+#### Exchanges
+- dydx (v3)
+- dydx v4

notebooks/example_dydx_v3.ipynb

@@ -4,17 +4,11 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Intro\n",
+    "## Description\n",
     "Running this notebook will create the file `locast.db` in the notebooks folder (if not yet present), containing a price candle cluster for ETH-USD.\n",
     "Note: All examples share the same `locast.db`. So if one creates it, the other one will use it automatically. \n",
     "Once it exists, re-running this notebook will attempt to update that cluster. Depending on how much time has passed, this might not be necessary yet.\n",
-    "\n",
-    "### Cluster\n",
-    "A cluster is a list of candle objects, representing a time series of price data. Per exchange, market and resolution, there can be exactly one cluster in the database. Once it is created, it can either be:\n",
-    "- retrieved \n",
-    "- deleted\n",
-    "- updated\n",
-    "- ... more to come\n"
+    "\n"
    ]
   },
   {

notebooks/example_dydx_v4.ipynb

@@ -4,9 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Intro\n",
-    "Running this notebook will create the file `locast.db` in the notebooks folder, containing a price candle cluster for ETH-USD. \n",
-    "Once it exists, re-running this notebook will attempt to update that cluster. Depending on how much time has passed, this might not be necessary yet. "
+    "## Description\n",
+    "Running this notebook will create the file `locast.db` in the notebooks folder (if not yet present), containing a price candle cluster for ETH-USD.\n",
+    "Note: All examples share the same `locast.db`. So if one creates it, the other one will use it automatically. \n",
+    "Once it exists, re-running this notebook will attempt to update that cluster. Depending on how much time has passed, this might not be necessary yet."
    ]
   },
   {