From b52faac854268bedd114c96cb106f30e3b89495d Mon Sep 17 00:00:00 2001
From: Kharec <sandro@cazzaniga.fr>
Date: Sun, 16 Nov 2025 15:32:23 +0100
Subject: [PATCH] docs: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a70931d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# ansible-role-freshrss
+
+This role deploys [FreshRSS](https://www.freshrss.org/) to your server(s).
+
+It **does not** deploy php, nor a webserver or a database. However, it does install the dependencies for FreshRSS, including php-sqlite3 in case you want to use a simple SQLite database.
+
+## Example playbook
+
+```yaml
+- name: Deploy FreshRSS
+  hosts: freshrss
+  become: true
+
+  roles:
+    - freshrss
+```
+
+## Example var file
+
+```yaml
+freshrss_root_dir: "/var/www"
+freshrss_path: "/var/www/rss"
+freshrss_version: "1.27.1"
+freshrss_refresh_interval: 15 # every 15 minutes
+```
+
+## FreshRSS configuration
+
+It's done once deployed, navigate to the address you’ve installed your server to complete the installation from the GUI.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 or later (GPLv3+). See the [LICENSE](LICENSE) file for details.