summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2021-03-26 14:14:43 +0300
committerYuval Adam <_@yuv.al>2021-03-26 14:14:43 +0300
commit39fa4e68ec3547a4c96824b562c8cf8ab14bf321 (patch)
tree3ea7baf21b1cb287e647fd2ae1664af7a51a3369 /README.md
parent6c58fdce42799df014bb926621a021833c8016db (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index 54bf5b5..3e150f7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,19 @@
# Israeli Election Data
+
+Election data for the last (4, and counting) election cycles in Israel from 2019.
+
+## Data
+
+- Data by ballots in [`ballots/`](ballots)
+- Data by cities in [`cities/`](cities)
+
+## Dev
+
+```bash
+$ pipenv sync
+$ pipenv run jupyter notebook
+```
+
+## Just show me the data
+
+Go to the rendered notebook at [stats.py.ipynb](stats.py.ipynb)