Readme

1 files changed, 26 insertions, 0 deletions

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..443d2e2
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,26 @@
+# rss-to-gitea
+
+## Usage
+
+```
+rsstogitea config.yml
+```
+
+## Configuration
+
+```yaml
+---
+url: 'https://gitea.example.com'
+token: 'env/GITEA_TOKEN'
+owner: 'org'
+repo: 'repo'
+label: 'update'
+feeds:
+  - url: 'https://github.com/go-gitea/gitea/releases.atom'
+    name: 'Gitea'
+    assign: 'user'
+    exclude:
+      - dev
+      - rc
+    include: []
+```