From 06bdd9fdd90a308c3e91a459021e0c4acd640032 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rub=C3=A9n=20Ruiz?= <ruben@ruizt.net>
Date: Sun, 21 Apr 2024 10:31:47 +0200
Subject: [PATCH] documentation: add README file

---
 README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8d4c783
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+# Omnivore as RSS
+
+This application queries the Omnivore API to get the latest articles and exposes an RSS feed with them. 
+
+You can use it for applications or devices that don't support integration with Omnivore directly, but do support RSS. ie. [KOReader](https://koreader.rocks/)
+
+## Usage
+
+### Using Docker
+
+1. Get your [Omnivore authentication token](https://docs.omnivore.app/integrations/api.html#getting-an-api-token)
+
+2. Run the Docker Image
+
+```shell
+docker run -p 8090:8090 -e OMNIVORE_AUTH_TOKEN='[YOUR-AUTH-TOKEN]' /omnivore-to-rss:latest-amd64
+```
+
+3. Access the endpoint with your preferred software
+
+```shell
+curl http://localhost:8090/rss
+```
+
+You can use Docker Compose as well:
+
+```yaml
+services:
+  omnivore-as-rss:
+    image: rruizt/omnivore-as-rss:latest
+    restart: unless-stopped
+    environment:
+      - OMNIVORE_AUTH_TOKEN=[YOUR_AUTH_TOKEN]
+    ports:
+      - "8090:8090"
+    healthcheck:
+      test: ["CMD", "wget" ,"--no-verbose", "--tries=1", "http://localhost:8090/rss"]
+      interval: 1m
+      timeout: 3s
+```
+
+### Using the binaries
+
+#### Linux/MacOS
+
+1. Download the released tar.gz for Linux or MacOS (Darwin) from [here](https://github.com/rruizt/omnivore-as-rss/releases/latest)
+2. Decompress the file and run the binary with the right flags
+
+```
+./omnivore-as-rss -t=00000000-0000-0000-0000-000000000000 
+```
+
+#### Windows
+
+1. Download the released zip for Windows from [here](https://github.com/rruizt/omnivore-as-rss/releases/latest)
+2. Decompress the file and run the .exe file with the right flags
+
+ie.
+```
+omnivore-as-rss.exe -t=00000000-0000-0000-0000-000000000000 
+```
+
+
+## Configuration
+
+You can configure `omnivore-as-rss` with environment variables or command line flags
+
+| Environment Var / Flag  | Description | Example |
+| ------------- | ------------- |-----------|
+| OMNIVORE_AUTH_TOKEN / -t  | The API token from Omnivore  | `00000000-0000-0000-0000-000000000000` |
+| OMNIVORE_AUTH_TOKEN_FILEPATH / -tf | The filepath of the file containing the API token from Omnivore | `/run/secrets/omnivore` |
+
+
+