From 5126b9c3dbd50d6e270a0adef2b69bd1eb0b9ca3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Adam=20=C5=A0trauch?= <cx@initd.cz>
Date: Thu, 8 Aug 2024 01:34:21 +0200
Subject: [PATCH] README update

---
 README.md    | 12 ++++++++++++
 Taskfile.yml |  3 +++
 2 files changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4a1d3fd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Home energy calculator of spot market prices
+
+This project is an API that provides endpoints to give you easily processable data from Czech spot market.
+
+To run it yourself run this:
+
+```
+python -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+fastapi dev calculator/main.py --reload
+```
diff --git a/Taskfile.yml b/Taskfile.yml
index 31bcb95..2ceafd3 100644
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -3,6 +3,9 @@
 version: '3'
 
 tasks:
+  dev :
+    cmds:
+    - fastapi dev calculator/main.py --reload
   deploy:
     cmds:
       - ssh -p 11335 app@ssh.rosti.cz mkdir -p /srv/app/cache