Merge pull request #22 from iokiwi/new/update-readme

Update readme with directions for updated service

Author: FelisNigelus

README.md

@@ -1,12 +1,92 @@
-# Chat
+# NZPUG Chat
 
-https://chat.python.nz
+<img src="doc/images/riot_web_python_nz_home.png" width="250px"/><img src="doc/images/riot_im_dark.png" width="250px"/><img src="doc/images/riot_im_light.png" width="250px"/>
 
+The New Zealand Python User Group hosts a [Matrix](https://matrix.org/) chat server and [Riot](https://about.riot.im/) web client for the use of its members and the wider Python community in New Zealand.
 
-## Registration
+[Matrix](https://matrix.org/) is a free an open source chat solution and riot [Riot](https://about.riot.im/) is a free and open source client for matrix available on the web, on mobile and on the desktop.
 
-1. Go to https://chat.python.nz/#/register
-2. Click `Create an account`
-3. Sign up *with* your email address (without it you won't be able to reset your password)
-4. Verify your email
-5. Log in and join chat rooms
+## Get Started
+
+1. Visit https://chat.python.nz in your browser.
+2. Create an account or sign in.
+<details>
+    <summary id="create-account">Create an Account</summary>
+
+1. Click on **Create Account**
+2. Set a username and password
+3. Enter your email address (recommended)
+
+
+**Note:** Your email address is required to reset your password or recover 
+your account if you get locked out. You can add, edit or remove email 
+address at any stage via your profile.
+
+![riot_web_python_nz_create_account.png](doc/images/riot_web_python_nz_create_account.png)
+
+</details>
+
+<details>
+    <summary id="sign-in">Sign in</summary>
+
+1. Select **Sign In**
+2. Log in with your username and password.
+
+![riot_web_python_nz_sign_in.png](doc/images/riot_web_python_nz_sign_in.png)
+</details>
+
+
+
+## Mobile
+
+For Riot Mobile you need to set the `Homeserver` URL to `https://chat.python.nz` manually when signing in or registering.
+
+<details>
+    <summary>Create Account</summary>
+
+
+ 1. Check the **'☑️ Use custom server options (advanced)'** option
+ 2. Enter `https://chat.python.nz` as the `Home Server URL`
+ 3. Sign up with your email address
+
+<img src="doc/images/riot_mobile_python_nz_create_account.jpg" width="200px"/>
+
+</details>
+
+<details>
+    <summary>Sign in</summary>
+
+ 1. Check the **'☑️ Use custom server options (advanced)'** option
+ 2. Enter `https://chat.python.nz` as the `Home Server URL`
+ 3. Sign in with your username or email address and password
+
+<img src="doc/images/riot_mobile_python_nz_sign_in.jpg" width="200px"/>
+
+</details>
+
+
+## Desktop and Riot Web
+
+For Riot Desktop and Riot Web (https://riot.im/app) you need to set the NZPUG `Homeserver URL` to `https://chat.python.nz` manually before signing in or registering.
+
+<details>
+    <summary>Step by step instructions</summary>
+
+
+1. Click **Change** next to the text "*Sign in to your account on matrix.org*"
+
+![riot_desktop_sign_in_matrix_org_edited.png](doc/images/riot_desktop_signin_matrix_org_edited.png)
+
+2. For the `Homeserver URL` type in `https://chat.python.nz`
+
+![riot_desktop_sign_in_other_servers.png](doc/images/riot_desktop_sign_in_other_servers.png)
+
+3. Click **Next** To continue.
+
+Now you can [sign in](#sign-in) or [create an account](#create-account) on the chat.python.nz homeserver.
+
+## Maintainer Notes
+
+‼️ Do not run these Ansible or Terraform scripts. The configuration in production has diverged from these scripts and running them will revert local changes.
+
+A task to update and test the scripts is being tracked here (https://github.com/nzpug/chat/issues/11)