IQAir api access crate
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..850b2a3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# iqair
+
+provides access to iqair's numbers.
+uses the `nearest_city` endpoint.
+
+use either as library or binary.
+binary usage allows
+
+```
+> iqair API-KEY
+96
+```