From b0355b0beb0e51889d883f4a3c4e7a77832dbc6f Mon Sep 17 00:00:00 2001
From: Thumbscrew <thumbscrw@pm.me>
Date: Tue, 5 Apr 2022 15:56:31 +0100
Subject: [PATCH] update README with examples

---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2f70fea..496d02d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,56 @@
 # PSMatrix
-PowerShell module for interacting with the Matrix API
\ No newline at end of file
+PowerShell module for interacting with the Matrix API
+
+## Installation
+
+1. Clone repo:
+
+```bash
+git clone https://github.com/Thumbscrew/PSMatrix.git
+```
+
+2. Import module:
+
+```powershell
+Import-Module ./PSMatrix
+```
+
+## Getting Started
+
+1. Create a `PSCredential` object:
+
+```powershell
+$creds = Get-Credential
+
+PowerShell credential request
+Enter your credentials.
+User: username
+Password for user username: **************
+```
+
+2. Get an access token from your Matrix homeserver (this will be required for subsequent authenticated requests):
+
+```powershell
+# DeviceDisplayName is optional and will default to "PSMatrix"
+$token = New-MatrixAccessToken -ServerUrl "https://example.matrix.com" -Credentials $creds -DeviceDisplayName "PSMatrix"
+```
+
+## Examples
+
+### Get a list Matrix rooms you've joined
+
+```powershell
+$rooms = Get-MatrixJoinedRooms -ServerUrl "https://matrix.example.com" -AccessToken $token
+```
+
+### Get all members of a joined room
+
+```powershell
+Get-MatrixJoinedMembers -ServerUrl "https://matrix.example.com" -AccessToken $token -RoomId "!ehXvUhWNASUkSLvAGP:matrix.org"
+```
+
+### Log out of your session
+
+```powershell
+Remove-MatrixAccessToken -ServerUrl "https://matrix.example.com" -AccessToken $token
+```