From c2837f51008cadeecd0d91d024d539f7373abffe Mon Sep 17 00:00:00 2001
From: Jake Howard <git@theorangeone.net>
Date: Fri, 5 May 2023 11:44:01 +0100
Subject: [PATCH] Add project README

---
 README.md | 13 +++++++++++++
 report.py |  0
 2 files changed, 13 insertions(+)
 create mode 100644 README.md
 mode change 100644 => 100755 report.py

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..14324da
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Plausible Page Report
+
+Create a CSV of all page views by URL. Plausible has a [page stats export](https://plausible.io/docs/export-stats), but this silently limits itself to the 100 most viewed pages. It does however have an [API](https://plausible.io/docs/stats-api#get-apiv1statsbreakdown).
+
+## Usage
+
+Create an API key, and export it as `$PLAUSIBLE_API_TOKEN`
+
+```
+python3 report.py <hostname>
+```
+
+If you run your own Plausible instance ([like me](https://theorangeone.net/posts/self-hosting-plausible/)), set `$PLAUSIBLE_HOST`.
diff --git a/report.py b/report.py
old mode 100644
new mode 100755