more detailed readmes

climatepolicyradar · Nov 3, 2024 · 276b36b · 276b36b
1 parent 2de5812
commit 276b36b
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
 # Climate Policy Radar Open Data
 
 This repo contains helpers for our open data, which you can find on [Huggingface](https://huggingface.co/ClimatePolicyRadar/all-document-text-data).
+
+## Getting started
+
+The best place to get started is the loading data notebook at `src/notebooks`.
+
+Other examples of notebooks and streamlit demos using this open data are in the `src` directory. Feel free to raise an issue if you'd like to add or propose an interesting use case for this data.
diff --git a/src/streamlit_apps/README.md b/src/streamlit_apps/README.md
@@ -0,0 +1,7 @@
+# Streamlit apps
+
+## Searchable World Map
+
+A demonstration of plotting maps using Climate Policy Radar data. This app allows you to compare the relative use of different keywords in this data across the world.
+
+![A screenshot of the world map demo](world_map_screenshot.png)
diff --git a/src/streamlit_apps/world_map_screenshot.png b/src/streamlit_apps/world_map_screenshot.png