add README

fneum · Jun 1, 2023 · 86f9b6c · 86f9b6c
1 parent 9c25fe9
commit 86f9b6c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,3 @@
-__pychache__
+__pycache__
 .ipynb_checkpoints
-develop.ipynb_checkpoints
+develop.ipynb
diff --git a/README.md b/README.md
@@ -1 +1,24 @@
-# spatial-sector-dashboard
+# Streamlit Dashboard for "The Potential Role of a Hydrogen Network in Europe"
+
+Code for interactive dashboard for results exploration.
+
+See live version at: [h2-network.streamlit.app](httsp://h2-network.streamlit.app)
+
+## Local Installation and Usage
+
+Install dependencies:
+
+```sh
+pip install -r requirements.txt
+```
+
+Start interactive dashboard:
+
+```sh
+streamlit run streamlit_app.py
+```
+
+## License
+
+[MIT](LICENSE)
+