Skip to content

Commit 2e6376f

Browse files
authored
Release v0.0.10 (#333)
1 parent 480888a commit 2e6376f

File tree

3 files changed

+34
-34
lines changed

3 files changed

+34
-34
lines changed

Cargo.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "iamb"
3-
version = "0.0.10-alpha.1"
3+
version = "0.0.10"
44
edition = "2018"
55
authors = ["Ulyssa <git@ulyssa.dev>"]
66
repository = "https://github.com/ulyssa/iamb"

README.md

+32-32
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Threads, spaces, E2EE, and read receipts
1919
- Image previews in terminals that support it (sixels, Kitty, and iTerm2), or using pixelated blocks for those that don't
2020
- Notifications via terminal bell or desktop environment
21+
- Send Markdown, HTML or plaintext messages
2122
- Creating, joining, and leaving rooms
2223
- Sending and accepting room invitations
2324
- 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]
3132
You can find documentation for installing, configuring, and using iamb on its
3233
website, [iamb.chat].
3334

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`)
3555

3656
Install Rust (1.70.0 or above) and Cargo, and then run:
3757

3858
```
3959
cargo install --locked iamb
4060
```
4161

62+
See [Configuration](#configuration) for getting a profile set up.
63+
64+
## Installation (via package managers)
65+
4266
### Arch Linux
4367

4468
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
4872
paru iamb-git
4973
```
5074

51-
See [Configuration](#configuration) for getting a profile set up.
52-
5375
### FreeBSD
5476

5577
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
5880
pkg install iamb
5981
```
6082

61-
### NetBSD
83+
### macOS
6284

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:
6487

6588
```
66-
pkgin install iamb
89+
brew install iamb
6790
```
6891

69-
### macOS
92+
### NetBSD
7093

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:
7395

7496
```
75-
brew install iamb
97+
pkgin install iamb
7698
```
7799

78100
### Nix / NixOS (flake)
@@ -97,33 +119,11 @@ A snap for Linux distributions which [support](https://snapcraft.io/docs/install
97119
snap install iamb
98120
```
99121

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-
119122
## License
120123

121124
iamb is released under the [Apache License, Version 2.0].
122125

123126
[Apache License, Version 2.0]: https://github.com/ulyssa/iamb/blob/master/LICENSE
124-
[client-comparison-matrix]: https://matrix.org/clients-matrix/
125127
[crates-io-iamb]: https://crates.io/crates/iamb
126128
[iamb.chat]: https://iamb.chat
127-
[gomuks]: https://github.com/tulir/gomuks
128-
[weechat-matrix]: https://github.com/poljar/weechat-matrix
129129
[well_known_entry]: https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient

0 commit comments

Comments
 (0)