Add README.md

README.md

@@ -0,0 +1,40 @@
+# **matrix_rss_docker**
+
+This is the docker for my [matrix_rss](https://gitlab.com/Mageas/matrix_rss) project.
+
+### **Configuration of matrix_rss**
+
+Copy [config_example.json](https://gitlab.com/Mageas/matrix_rss/-/blob/55866cbe34b7a3dc8a4a05dd8c5fd2624222a65f/config_example.json) form the **matrix_rss** project as *config.json* in your directory.
+
+Update *config.json* with your informations (for more informations about the *config.json* [here](https://gitlab.com/Mageas/matrix_rss)).
+
+### **Configuration of docker-compose**
+
+Create a *docker-compose.yml* file in your directory.
+
+Content of docker-compose.yml:
+```yml
+version: '3.5'
+services:
+  matrix_rss:
+    image: registry.gitlab.com/mageas/matrix_rss_docker
+    volumes:
+      - ./config.json:/app/config.json
+      - database:/app/sled_db
+    environment:
+      - UID=1000
+      - GID=1000
+
+volumes:
+  database:
+```
+
+Explanations of docker-compose:
+- `./config.json:/app/config.json` sync your config with the container
+- `database:/app/sled_db` save your database with the host
+- `UID=1000` change the container user id
+- `GID=1000` change the container group id
+
+### **Run the container**
+
+`docker-compose up -d`