README.md

@@ -1,3 +1,21 @@
+# HedgeDoc-HedgeAgent
+
+This is a customized version that makes it possible to invite an AI agent to a note via the menu. "Invite Agent" sends the `note_id` to hedgeagent.
+
+To start an instance for development, the following is required:
+1. ```cp config.json.example config.json ```
+2. Update ```"domain": "change this" ```
+3. ```.yarn/releases/yarn-4.12.0.cjs install```
+4. ```.yarn/releases/yarn-4.12.0.cjs run build```
+5. ```.yarn/releases/yarn-4.12.0.cjs start```
+
+To start for production:
+1. `docker compose up -d`
+
+Note: Use UID 10000 for data folders.
+
+---
+
 ![HedgeDoc Logo](docs/content/images/hedgedoc_logo_black.svg)
 
 # HedgeDoc