Update for v0.0.8 release (#13)

src/commands.md

@@ -11,7 +11,8 @@
 | `:invite accept`    |                                       | See [Room Invitations]              |
 | `:invite reject`    |                                       | See [Room Invitations]              |
 | `:invite send`      |                                       | See [Room Invitations]              |
-| `:join`             |                                       | See [Rooms]                         |
+| `:join`             |                                       | See [Joining And Leaving Rooms]     |
+| `:leave`            |                                       | See [Joining And Leaving Rooms]     |
 | `:members`          |                                       | See [Viewing Room/Space Members]    |
 | `:open`             |                                       | See [Downloading Attachments]       |
 | `:react`            |                                       | See [Reacting To A Message]         |
@@ -84,7 +85,7 @@ table th:nth-of-type(3) {
 [Replying To A Message]: ./messages/#replying-to-a-message
 [Room Creation]: ./rooms/management.md#room-creation
 [Room Invitations]: ./rooms/management.md#room-invitations
-[Rooms]: ./rooms/
+[Joining And Leaving Rooms]: ./rooms/#joining-and-leaving-rooms
 [Sending]: ./messages/#sending
 [Setting Room Properties]: ./rooms/management.md#setting-room-properties
 [Setting Room Tags]: ./rooms/management.md#setting-room-tags

src/configure.md

@@ -42,6 +42,7 @@ Logging in for @user1:example.com...
 | ---------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
 | `default_room`               |                      | A default room name or username to open at startup, in place of showing the welcome screen.                                       |
 | `log_level`                  | `"info"`             | Configures the minimum log level. Valid values are `"trace"`, `"debug"`, `"info"`, `"warn"` or `"error"`.                         |
+| `open_command`               |                      | Configures a command to use for opening downloads instead of the default. (e.g., `["my-open", "--file"]` to run a custom script   |
 | `request_timeout`            | 120                  | How long to wait in seconds before timing out requests to the homeserver.                                                         |
 | `reaction_display`           | `true`               | Whether to display message reactions. You can use this or `reaction_shortcode_display` if your terminal doesn't show Emojis well. |
 | `reaction_shortcode_display` | `false`              | Whether to show the shortcode value instead of the Emoji for reactions. If no shortcode is available, then it won't be displayed. |
@@ -50,6 +51,7 @@ Logging in for @user1:example.com...
 | `typing_notice_send`         | `true`               | Whether to send notifications to other room members when typing.                                                                  |
 | `typing_notice_display`      | `true`               | Whether to display the typing notifications bar.                                                                                   |
 | `users`                      | `{}`                 | Configure how other users get displayed in the client. See [User Display](#user-display).                                         |
+| `username_display`           | `"username"`         | Configure what name is shown for senders. Valid values are `"username"` (e.g., `@user:example.org`), `"localpart"` (e.g., `user`), or `"displayname"` (e.g., `User Name`) |
 
 For example, if you wanted to raise the timeout to accommodate a long initial
 sync, and show more log messages, you could put the following into your
@@ -64,6 +66,67 @@ sync, and show more log messages, you could put the following into your
 }
 ```
 
+## Startup Layout
+
+You can configure what windows get shown when __iamb__ starts by adding a
+`"layout"` object.
+
+### Restore Previous Layout
+
+By default, the client will try to restore all of the tabs and windows from the
+last time it was run. You can explicitly configure this behaviour with:
+
+```json
+{
+    "layout": { "style": "restore" }
+}
+```
+
+### New Window
+
+If you want to see a single new window each time you start up, you can set:
+
+```json
+{
+    "layout": { "style": "new" }
+}
+```
+
+This will show the `:welcome` window by default, but you can set
+`"default_room"` to change it to something else.
+
+### Configured Layout
+
+If you want to start up with the same layout every time regardless of the state
+at last exit, you can specify an array of tabs and the window tree in each one:
+
+```json
+{
+    "layout": {
+        "style": "config",
+        "tabs": [
+            {
+                "split": [
+                    { "window": "#room1:example.org" },
+                    { "window": "#room2:example.org" }
+                ]
+            },
+            {
+                "split": [
+                    {
+                        "split": [
+                            { "window": "#room3:example.org" },
+                            { "window": "#room4:example.org" }
+                        ]
+                    },
+                    { "window": "@user:example.org" }
+                ]
+            }
+        ]
+    }
+}
+```
+
 ## Directories
 
 __iamb__ will use the standard directories for your operating system, but you

src/install.md

@@ -17,6 +17,18 @@ paru iamb-git
 pkgin install iamb
 ```
 
+### NixOS
+
+There is an `iamb` package available in the 23.05 channel, or, if you have
+[enabled flakes] in Nix, you can install __iamb__ from the Git repository via:
+
+```
+nix profile install "github:ulyssa/iamb/latest"
+```
+
+You can replace `latest` with a branch or specific version tag name if you want
+to install something besides the most recent release (e.g. `main` or `v0.0.8`).
+
 ## GitHub Releases
 
 You can find binaries built for x86\_64 Linux from the [Releases] page on GitHub.
@@ -43,10 +55,11 @@ $ git clone https://github.com/ulyssa/iamb.git
 $ cd iamb
 $ cargo build --release
 $ ./target/release/iamb --version
-iamb 0.0.7
+iamb 0.0.8 (89bb107)
 ```
 
 [AUR helper]: https://wiki.archlinux.org/title/AUR_helpers
 [crates.io]: https://crates.io/crates/iamb
+[enabled flakes]: https://nixos.wiki/wiki/Flakes#Enable_flakes
 [GitHub]: https://github.com/ulyssa/iamb
 [Releases]: https://github.com/ulyssa/iamb/releases/

src/messages/README.md

@@ -17,6 +17,9 @@ focused room:
 :upload "/home/user/Documents/Shared Document.pdf"
 ```
 
+Clipboard images can be uploaded by pasting from the clipboard register `"*p`,
+and following the confirmation dialog.
+
 ## Message Scrollback
 
 You can scroll through messages from the message bar using the following keys:

src/rooms/README.md

@@ -1,6 +1,6 @@
 # Rooms
 
-## Joining A New Room
+## Joining And Leaving Rooms
 
 You can join a new room or space using the `:join` command. For example, to
 join the Matrix community space, you can run:
@@ -14,3 +14,10 @@ You can similarly start a new direct message:
 ```
 :join @user:example.com
 ```
+
+You can leave the currently focused room via the `:leave` command. This will
+prompt for confirmation by default, but you can override it by appending `!`:
+
+```
+:leave!
+```