Refactor documentation.

README.md

@@ -1,3 +1,8 @@
+[![License: CC BY-NC 4.0](https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by-nc/4.0/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fairiskdata)
+![PyPI](https://img.shields.io/pypi/v/fairiskdata)
+[![Downloads](https://pepy.tech/badge/fairiskdata)](https://pepy.tech/project/fairiskdata)
+
 # FAIRisk | Improving risk estimation with open resources
 
 FAIRisk combines open-source globally available data related with risk scales and country preparedness for epidemic 
@@ -31,10 +36,15 @@ Check out our [architecture documentation](./docs/Architecture.md) for more deta
 
 ### Getting started
 
-Jump to our [getting started guide](./docs/GettingStarted.md). 
-Data exploration, visualization, and export is also possible using [our simple streamlit application](./docs/Streamlit.md).
-Also, you may read our [full documentation](./docs/index.md).
+You can install our python package using pip:
+
+```bash
+pip install fairiskdata
+```
+
+We have compiled a [sample notebook](./sample.ipynb) to demonstrate the use of the library and its methods.
 
+For additional information check the [getting started guide](./docs/GettingStarted.md) or [the full documentation](./docs/index.md).
 
 ### License
 

docs/GettingStarted.md

@@ -12,3 +12,22 @@ pip install fairiskdata
 
 We have compiled a sample notebook to demonstrate the use of the library and its methods.
 You can access it [here](../sample.ipynb).
+
+[These are the instructions to configure the logging level](./Logging.md)
+
+### Streamlit
+
+A [streamlit](https://streamlit.io/) web app is included in this project with a demonstrator for parameters and time-series data.
+
+The web app allows the user to do operations on the dataset, visualize it, and export to a CSV. To run the application, its dependencies need to be installed before running the application.
+
+Install the requirements:
+```bash
+pip install -r docs/streamlit/requirements.txt
+```
+
+Run the web app:
+```bash
+streamlit run docs/streamlit/home_streamlit.py
+```
+ By default, the web app will be accessible from http://localhost:8501/

docs/index.md

@@ -1,11 +1,7 @@
 # Documentation
 
-Structure
-
 1. [Architecture](./Architecture.md)
 2. [Source Datasets](./SourceDatasets.md)
 3. [Getting started](./GettingStarted.md)
 4. [Data structures](./InternalDatamodel.md)
 5. [API Reference](./api_reference/fairiskdata/fairisk_dataset.html)
-6. [Logging](./Logging.md)
-7. [Streamlit](./Streamlit.md)