aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2021-06-04 15:05:43 +0200
committerJonas Smedegaard <dr@jones.dk>2021-06-04 15:05:43 +0200
commite4fe11758629c242a79c6a57df8c358cb33327e9 (patch)
treee717f56653d807e8a376368ea1ec48a84567bfbd
parentb64dde43639e293504f113aa724401ebfcd01d41 (diff)
use inline defined hints
-rw-r--r--README.md10
-rw-r--r--USE.md15
2 files changed, 21 insertions, 4 deletions
diff --git a/README.md b/README.md
index 135e440..3521748 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,16 @@
# Text-based chat with the Matrix protocol _(chat-matrix)_
-{{domain}} offers chatrooms.
+Example orga offers chatrooms.
All chatrooms are public accessible.
Users can create a chat account and connect directly.
Anyone can connect indirectly
via servers part of the federated Matrix chat netork.
+
+
+## Special strings
+
+NB! This documentation uses special strings
+which you may want to adapt for your local setup:
+
+organisation: Example orga
diff --git a/USE.md b/USE.md
index 517196b..f7c37cb 100644
--- a/USE.md
+++ b/USE.md
@@ -1,12 +1,21 @@
# Using text-based chat with the Matrix protocol
-Anyone can access chatrooms at domain {{domain}}.
+Anyone can access chatrooms at domain example.org.
You can create a personal [[account]] to access the chat service directly.
You can access the service indirectly via another Matrix chat service.
+## Special strings
+
+NB! This documentation uses special strings
+which you may want to adapt for your local setup:
+
+domain: example.org
+matrixhost: matrix.example.org
+
+
## Clients
Matrix chat is accessed with any of several [Matrix clients].
@@ -33,11 +42,11 @@ You can use several clients at once.
## Setup
-Members can create an account locally at the domain {{domain}}.
+Members can create an account locally at the domain example.org.
Guests may connect indirectly from another Matrix network.
To create a local member account,
-tell your Matrix client to use the chatserver {{matrixhost}}
+tell your Matrix client to use the chatserver matrix.example.org
(some Matrix clients call it "Custom server" or "Home server").
Then request to create a new account,
providing your email address as proof of membership