From 6c617b969db2e2fd8ee5a6c0a2bbf0dbe969ae50 Mon Sep 17 00:00:00 2001
From: 8baller <8ball030@gmail.com>
Date: Thu, 9 Nov 2023 17:20:01 +0100
Subject: [PATCH] [feat] readme.

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index e69de29..4ec8ba0 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,29 @@
+# Lyra V2 Python Client.
+
+This repo provides a unified interface for the Lyra V2 Exchange.
+
+## Dev
+
+### Formatting
+
+```bash
+make fmt
+```
+
+### Linting
+
+```bash
+make lint
+```
+
+### Tests
+
+```bash
+make tests
+```
+
+For convience, all commands can be run with;
+
+```
+make all
+```