18
18
- Threads, spaces, E2EE, and read receipts
19
19
- Image previews in terminals that support it (sixels, Kitty, and iTerm2), or using pixelated blocks for those that don't
20
20
- Notifications via terminal bell or desktop environment
21
+ - Send Markdown, HTML or plaintext messages
21
22
- Creating, joining, and leaving rooms
22
23
- Sending and accepting room invitations
23
24
- Editing, redacting, and reacting to messages
@@ -31,14 +32,37 @@ _You may want to [see this page as it was when the latest version was published]
31
32
You can find documentation for installing, configuring, and using iamb on its
32
33
website, [ iamb.chat] .
33
34
34
- ## Installation
35
+ ## Configuration
36
+
37
+ You can create a basic configuration in ` $CONFIG_DIR/iamb/config.toml ` that looks like:
38
+
39
+ ``` toml
40
+ [profiles ."example .com" ]
41
+ user_id = " @user:example.com"
42
+ ```
43
+
44
+ If you homeserver is located on a different domain than the server part of the
45
+ ` user_id ` and you don't have a [ ` /.well-known ` ] [ well_known_entry ] entry, then
46
+ you can explicitly specify the homeserver URL to use:
47
+
48
+ ``` toml
49
+ [profiles ."example .com" ]
50
+ url = " https://example.com"
51
+ user_id = " @user:example.com"
52
+ ```
53
+
54
+ ## Installation (via ` crates.io ` )
35
55
36
56
Install Rust (1.70.0 or above) and Cargo, and then run:
37
57
38
58
```
39
59
cargo install --locked iamb
40
60
```
41
61
62
+ See [ Configuration] ( #configuration ) for getting a profile set up.
63
+
64
+ ## Installation (via package managers)
65
+
42
66
### Arch Linux
43
67
44
68
On Arch Linux a [ package] ( https://aur.archlinux.org/packages/iamb-git ) is available in the
@@ -48,8 +72,6 @@ Arch User Repositories (AUR). To install it simply run with your favorite AUR he
48
72
paru iamb-git
49
73
```
50
74
51
- See [ Configuration] ( #configuration ) for getting a profile set up.
52
-
53
75
### FreeBSD
54
76
55
77
On FreeBSD a package is available from the official repositories. To install it simply run:
@@ -58,21 +80,21 @@ On FreeBSD a package is available from the official repositories. To install it
58
80
pkg install iamb
59
81
```
60
82
61
- ### NetBSD
83
+ ### macOS
62
84
63
- On NetBSD a package is available from the official repositories. To install it simply run:
85
+ On macOS a [ package] ( https://formulae.brew.sh/formula/iamb#default ) is availabe in Homebrew's
86
+ repository. To install it simply run:
64
87
65
88
```
66
- pkgin install iamb
89
+ brew install iamb
67
90
```
68
91
69
- ### macOS
92
+ ### NetBSD
70
93
71
- On macOS a [ package] ( https://formulae.brew.sh/formula/iamb#default ) is availabe in Homebrew's
72
- repository. To install it simply run:
94
+ On NetBSD a package is available from the official repositories. To install it simply run:
73
95
74
96
```
75
- brew install iamb
97
+ pkgin install iamb
76
98
```
77
99
78
100
### Nix / NixOS (flake)
@@ -97,33 +119,11 @@ A snap for Linux distributions which [support](https://snapcraft.io/docs/install
97
119
snap install iamb
98
120
```
99
121
100
- ## Configuration
101
-
102
- You can create a basic configuration in ` $CONFIG_DIR/iamb/config.toml ` that looks like:
103
-
104
- ``` toml
105
- [profiles ."example .com" ]
106
- user_id = " @user:example.com"
107
- ```
108
-
109
- If you homeserver is located on a different domain than the server part of the
110
- ` user_id ` and you don't have a [ ` /.well-known ` ] [ well_known_entry ] entry, then
111
- you can explicitly specify the homeserver URL to use:
112
-
113
- ``` toml
114
- [profiles ."example .com" ]
115
- url = " https://example.com"
116
- user_id = " @user:example.com"
117
- ```
118
-
119
122
## License
120
123
121
124
iamb is released under the [ Apache License, Version 2.0] .
122
125
123
126
[ Apache License, Version 2.0 ] : https://github.com/ulyssa/iamb/blob/master/LICENSE
124
- [ client-comparison-matrix ] : https://matrix.org/clients-matrix/
125
127
[ crates-io-iamb ] : https://crates.io/crates/iamb
126
128
[ iamb.chat ] : https://iamb.chat
127
- [ gomuks ] : https://github.com/tulir/gomuks
128
- [ weechat-matrix ] : https://github.com/poljar/weechat-matrix
129
129
[ well_known_entry ] : https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
0 commit comments