From 217a68f309f5cb8bc364ba2589fa31b7620c6eb7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julian-Samuel=20Geb=C3=BChr?= <julian-samuel@gebuehr.net>
Date: Tue, 6 Sep 2022 20:12:54 +0200
Subject: [PATCH] Add documentation on client

---
 docs/configuring-playbook-cactus-comments.md  | 24 ++++++++++++++++++-
 .../tasks/setup_install.yml                   |  1 +
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md
index e64c4c06e..b3bc10571 100644
--- a/docs/configuring-playbook-cactus-comments.md
+++ b/docs/configuring-playbook-cactus-comments.md
@@ -38,4 +38,26 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
 
 ## Usage
 
-To learn how to use cactus comments message @bot.cactusbot:your-homeserver.com and type `help` or have a look in the [documentation](https://cactus.chat/docs/getting-started/quick-start/).
+To get started wit cactus comments message @bot.cactusbot:your-homeserver.com and type `help` to make sure it works.
+Then register a site by typing: `register <sitename>`. You will then be invited into a moderation room.
+Now you are good to go and can include the comment section on your website!
+
+**Careful:** To really make use of self-hosting you need change a few things in comparison to the official docs!
+
+Use the following snippet and make sure to replace `example.com` with your base domain!
+
+
+```html
+<script type="text/javascript" src="https://matrix.example.com/cactus-comments/cactus.js"></script>
+<link rel="stylesheet" href="https://matrix.example.com/cactus-comments/style.css" type="text/css">
+<div id="comment-section"></div>
+<script>
+initComments({
+  node: document.getElementById("comment-section"),
+  defaultHomeserverUrl: "https://matrix.example.com:8448",
+  serverName: "example.com",
+  siteName: "YourSiteName",
+  commentSectionId: "1"
+})
+</script>
+```
diff --git a/roles/matrix-cactus-comments/tasks/setup_install.yml b/roles/matrix-cactus-comments/tasks/setup_install.yml
index 39c5727c6..8652aabee 100644
--- a/roles/matrix-cactus-comments/tasks/setup_install.yml
+++ b/roles/matrix-cactus-comments/tasks/setup_install.yml
@@ -70,6 +70,7 @@
     url: https://latest.cactus.chat/cactus.js
     dest: "{{ matrix_cactus_comments_client_path }}/cactus.js"
     mode: "{{ matrix_cactus_comments_client_file_permissions }}"
+
 - name: Ensure client css file is downloaded
   ansible.builtin.get_url:
     url: https://latest.cactus.chat/style.css