aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index b3393d4..cb99cad 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
# Embed codimd pads into Discourse for libreho.st
-This allows you to embed libreho.st pads into discourse. Its based on https://github.com/fuerst/embed-etherpad-lite which embeds pads into posts using the Onebox mechanism.
+This allows you to embed libreho.st pads into discourse. It is based on https://github.com/fuerst/embed-etherpad-lite which embeds pads into posts using the Onebox mechanism.
# Usage
-After installation just insert codimd links into your Discourse posts or comments. The Etherpad will be embedded using the famous and beloved [IFRAME](https://en.wikipedia.org/wiki/HTML_element#Frames) tag and is fully operational.
+**This is meant to use with <https://talk.libreho.st>. You need to fork and adapt to your case.**
+
+After installation just insert codimd links into your Discourse posts or comments. The pad will be embedded using the famous and beloved [IFRAME](https://en.wikipedia.org/wiki/HTML_element#Frames) tag and is fully operational.
# Installation
@@ -18,5 +20,4 @@ The configuration line you have to add to your container's app.yml file looks li
# Details
-The plugin uses the ["Brand new plugin interface"](https://meta.discourse.org/t/brand-new-plugin-interface/8793/88) to change URL's like `http(s)://domain.tld/pad-id` into HTML code like `<iframe src='http(s)://domain.tld/pad-id'></iframe>`.
-
+The plugin uses the ["Brand new plugin interface"](https://meta.discourse.org/t/brand-new-plugin-interface/8793/88) to change URL's like `http(s)://domain.example/pad-id` into HTML code like `<iframe src='http(s)://domain.example/pad-id'></iframe>`.