updated readme

README.md

@@ -1,3 +1,35 @@
-# pnut-matrix
+# The Matrix <--> Pnut bridge
 
-Matrix bridge for pnut.io
+This is a pnut.io channel bridge for Matrix using the Application Services (AS) API.
+
+This bridge will pass pnut.io channel messages through to Matrix, and Matrix messages through to pnut.io channels.  Currently only public chat channels on pnut.io are supported but work is in progress to support private messages.
+
+
+## Usage
+
+To join a channel on pnut.io configured for public use:
+
+* `/join #pnut_ID:monkeystew.net` where ID is the id number of the channel on pnut.io
+* You can get the id number by looking at the URL when viewing the channel in patter.chat
+
+By default any messages you send will be posted as the matrixbot user on pnut.io with your display name.  You can however authorize pnut-matrix to post as your account instead.
+
+To link your Matrix ID with your pnut.io account:
+
+* Start a direct chat with `@pnut-bridge:monkeystew.net`
+* Type the `help` command to get started.
+
+
+## Questions, comments, or issues
+
+Join my development chat!
+
+**Matrix**
+
+* `/join #dev:monkeystew.net`
+
+**Pnut**
+
+* [monkeystew dev](https://patter.chat/room.html?channel=85)
+
+See [monkeystew.org/chat](https://monkeystew.org/chat) for additional information on accessing the chat room.