From b7ad785cb43a978cab34f9f01e1434c8ba7fe5cb Mon Sep 17 00:00:00 2001
From: bytedream <me@bytedream.dev>
Date: Wed, 22 Oct 2025 11:54:39 +0200
Subject: [PATCH] update readme

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index e69de29..1455481 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,5 @@
+# bambulab-store-tracker
+
+A script for scraping [bambulab store](https://store.bambulab.com/) filament availability, with a jupyter notebook for visualizing.
+
+The used endpoint was shut down on May 20th, 2025 and AFAIK there is no alternative to it. All scraped data can be found in [db.sqlite3](./db.sqlite3). You can use the [plot jupyter notebook](./plot.ipynb) to visualize the data.