aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2025-07-27 21:02:43 +0200
committerFuwn <[email protected]>2025-07-27 21:02:43 +0200
commit4fd35a986631c07ca6e8f3bda0812208ae1d3155 (patch)
tree9dd35d90b3b38717a875c48a28bc6af5a3b5cc9b
parentfeat: Add article scraper (diff)
downloadumapyai-4fd35a986631c07ca6e8f3bda0812208ae1d3155.tar.xz
umapyai-4fd35a986631c07ca6e8f3bda0812208ae1d3155.zip
docs: Add README
-rw-r--r--README.md14
-rw-r--r--pyproject.toml1
2 files changed, 15 insertions, 0 deletions
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]