initial commit

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6672034
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# countDistros
+
+these are just python scripts that scrape through [ProtonDB](https://www.protondb.com/) data (published [here](https://github.com/bdefore/protondb-data)), count how many times a distro is reported as being used, and can (optionally) display a pie chart showing the results.
+
+## examples
+
+to view plain text results:
+```sh
+python countdistros.py reports.json
+```
+
+to show a pie chart:
+```sh
+python countdistros_pichart.py reports.json
+```