chat.sr.ht: initial docs

1 files changed, 33 insertions, 0 deletions

diff --git a/chat.sr.ht/quickstart.md b/chat.sr.ht/quickstart.md
new file mode 100644
index 0000000..8cab29f
--- /dev/null
+++ b/chat.sr.ht/quickstart.md
@@ -0,0 +1,33 @@
+# chat.sr.ht quick-start for experienced IRC users
+
+The webchat is available at [chat.sr.ht](https://chat.sr.ht) and requires no
+configuration to use. It will automatically connect you to your bouncer account.
+
+You can also connect directly to the bouncer using your own IRC client.
+
+<!-- Note: update chat.sr.ht/bouncer-usage.md if changing this -->
+
+To connect with a third-party IRC client, you will need to generate an OAuth 2.0
+personal access token to use as your server password. Visit [the personal access
+token issuance page](https://meta.sr.ht/oauth2/personal-token) and set the
+grant string to "meta.sr.ht/PROFILE:RO", adding an optional comment, and leaving
+the other fields unchanged.
+
+**Hostname**: chat.sr.ht
+**Port**: 6697
+**SSL/TLS**: Yes
+**SASL**: Yes
+**Username**: *Your sourcehut username*
+**Password**: *Your personal access token*
+
+If you intend to use multiple clients, it is recommended that you append
+"@*clientname*" to your username, using an arbitrary unique string to identify
+each client. If your IRC client does not support soju's
+"soju.im/bouncer-networks" extension (check if [a plugin is available][config]),
+you may want to configure separate connections for each network by using the
+username format `username/network-name@client-name`.
+
+See [client-specific configuration][config] for recommended configuration steps
+specific to your preferred IRC client.
+
+[config]: /chat.sr.ht/bouncer-usage.md#client-specific-configuration