From 1ac2739f26dc725315263c5ba6f4ddadabd15aee Mon Sep 17 00:00:00 2001
From: w2 <w2@noreply.localhost>
Date: Mon, 9 May 2022 02:59:08 +0100
Subject: [PATCH] add: readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d8a86c4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+Prototype.
+- linux only (uses `/tmp/`)
+
+Download:
+- downloads either today or 2022-05-08 if today is unavailable
+- crashes if most recent hour does not have files yet (it is chehcked but fallback is not implemented)
+- prediction_time is hardcoded to 4
+
+Data:
+- returns data PER DOT (and in 20 seconds)
+-  opens the file like 10 times
+- latest hour is hardcoded to 18
+
+
+# Usage
+```
+uvicorn main:app --reload
+```
+
+```
+curl http://127.0.0.1:8000/download/ 
+curl 'http://127.0.0.1:8000/weather_dot/?lat=75&lon=0&prediction_time=004'
+```