From 4fd35a986631c07ca6e8f3bda0812208ae1d3155 Mon Sep 17 00:00:00 2001
From: Fuwn <contact@fuwn.me>
Date: Sun, 27 Jul 2025 21:02:43 +0200
Subject: docs: Add README

---
 README.md      | 14 ++++++++++++++
 pyproject.toml |  1 +
 2 files changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b02ff1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# 🏇 `umapyai`
+
+> Uma Musume: Pretty Derby Build Assistant (AI)
+
+## Usage
+
+```
+$ just scrape
+$ just run
+```
+
+## Licence
+
+This project is licensed under the [GNU General Public License v3.0](./LICENSE.txt).
diff --git a/pyproject.toml b/pyproject.toml
index 8667228..c831093 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -11,6 +11,7 @@ dependencies = [
     "loguru>=0.7.3",
     "beautifulsoup4>=4.13.4",
 ]
+readme = "README.md"
 requires-python = ">= 3.8"
 
 [project.scripts]
-- 
cgit v1.2.3