diff --git a/README.md b/README.md
new file mode 100644
index 0000000..90401cc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# gitea-rs
+
+This is just a simple generation of giteas openapi spec, compatibility not guaranteed.
+
+To regenerate the client:
+
+```
+cuddle x generate_gitea_client
+```