add README.md

obisidian-livesync/README.md

@@ -80,3 +80,47 @@ If everything is working correctly, a sync status icon should appear in the uppe
 
 This setup provides a fast and stable self-hosted Obsidian sync solution. However, keep in mind that maintenance, plugin updates, and LiveSync Docker container updates are the responsibility of the end user.
 
+# Obsidian LiveSync with CouchDB
+
+This configuration sets up a **CouchDB** container for **Obsidian LiveSync** with **Traefik** as a reverse proxy.
+
+## Prerequisites
+
+- Docker & Docker-Compose
+- Traefik as a reverse proxy
+- A configured `.env` file with the required environment variables
+
+## Environment Variables
+
+Copy `.env-example` to `.env` and adjust the values accordingly.
+
+## `local.ini` Configuration
+
+Modify the file `data/local.ini`:
+
+```ini
+[admins]
+admin = <SECRET_PASSWORD>
+```
+
+## Starting the Container
+
+Run the following command to start the container:
+
+```sh
+docker-compose up -d
+```
+
+## Testing the CouchDB Connection
+
+1. **Via Browser (Fauxton UI):**
+
+   ```
+   http://your.domain.com/_utils/
+   ```
+
+2. **Using cURL:**
+
+   ```sh
+   curl -u ${OBSIDIAN_COUCHDB_USER}:${OBSIDIAN_COUCHDB_PASSWORD} http://your.domain.com:5984/
+   ```