mirror of
https://github.com/youwen5/iamb.git
synced 2025-06-19 21:29:52 -07:00
Release v0.0.10 (#333)
This commit is contained in:
parent
480888a1fc
commit
2e6376ff86
3 changed files with 35 additions and 35 deletions
2
Cargo.lock
generated
2
Cargo.lock
generated
|
@ -2046,7 +2046,7 @@ dependencies = [
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "iamb"
|
name = "iamb"
|
||||||
version = "0.0.10-alpha.1"
|
version = "0.0.10"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"bitflags 2.5.0",
|
"bitflags 2.5.0",
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "iamb"
|
name = "iamb"
|
||||||
version = "0.0.10-alpha.1"
|
version = "0.0.10"
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
authors = ["Ulyssa <git@ulyssa.dev>"]
|
authors = ["Ulyssa <git@ulyssa.dev>"]
|
||||||
repository = "https://github.com/ulyssa/iamb"
|
repository = "https://github.com/ulyssa/iamb"
|
||||||
|
|
66
README.md
66
README.md
|
@ -18,6 +18,7 @@
|
||||||
- Threads, spaces, E2EE, and read receipts
|
- Threads, spaces, E2EE, and read receipts
|
||||||
- Image previews in terminals that support it (sixels, Kitty, and iTerm2), or using pixelated blocks for those that don't
|
- Image previews in terminals that support it (sixels, Kitty, and iTerm2), or using pixelated blocks for those that don't
|
||||||
- Notifications via terminal bell or desktop environment
|
- Notifications via terminal bell or desktop environment
|
||||||
|
- Send Markdown, HTML or plaintext messages
|
||||||
- Creating, joining, and leaving rooms
|
- Creating, joining, and leaving rooms
|
||||||
- Sending and accepting room invitations
|
- Sending and accepting room invitations
|
||||||
- Editing, redacting, and reacting to messages
|
- Editing, redacting, and reacting to messages
|
||||||
|
@ -31,7 +32,26 @@ _You may want to [see this page as it was when the latest version was published]
|
||||||
You can find documentation for installing, configuring, and using iamb on its
|
You can find documentation for installing, configuring, and using iamb on its
|
||||||
website, [iamb.chat].
|
website, [iamb.chat].
|
||||||
|
|
||||||
## Installation
|
## Configuration
|
||||||
|
|
||||||
|
You can create a basic configuration in `$CONFIG_DIR/iamb/config.toml` that looks like:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[profiles."example.com"]
|
||||||
|
user_id = "@user:example.com"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you homeserver is located on a different domain than the server part of the
|
||||||
|
`user_id` and you don't have a [`/.well-known`][well_known_entry] entry, then
|
||||||
|
you can explicitly specify the homeserver URL to use:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[profiles."example.com"]
|
||||||
|
url = "https://example.com"
|
||||||
|
user_id = "@user:example.com"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installation (via `crates.io`)
|
||||||
|
|
||||||
Install Rust (1.70.0 or above) and Cargo, and then run:
|
Install Rust (1.70.0 or above) and Cargo, and then run:
|
||||||
|
|
||||||
|
@ -39,6 +59,10 @@ Install Rust (1.70.0 or above) and Cargo, and then run:
|
||||||
cargo install --locked iamb
|
cargo install --locked iamb
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See [Configuration](#configuration) for getting a profile set up.
|
||||||
|
|
||||||
|
## Installation (via package managers)
|
||||||
|
|
||||||
### Arch Linux
|
### Arch Linux
|
||||||
|
|
||||||
On Arch Linux a [package](https://aur.archlinux.org/packages/iamb-git) is available in the
|
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
|
||||||
paru iamb-git
|
paru iamb-git
|
||||||
```
|
```
|
||||||
|
|
||||||
See [Configuration](#configuration) for getting a profile set up.
|
|
||||||
|
|
||||||
### FreeBSD
|
### FreeBSD
|
||||||
|
|
||||||
On FreeBSD a package is available from the official repositories. To install it simply run:
|
On FreeBSD a package is available from the official repositories. To install it simply run:
|
||||||
|
@ -58,14 +80,6 @@ On FreeBSD a package is available from the official repositories. To install it
|
||||||
pkg install iamb
|
pkg install iamb
|
||||||
```
|
```
|
||||||
|
|
||||||
### NetBSD
|
|
||||||
|
|
||||||
On NetBSD a package is available from the official repositories. To install it simply run:
|
|
||||||
|
|
||||||
```
|
|
||||||
pkgin install iamb
|
|
||||||
```
|
|
||||||
|
|
||||||
### macOS
|
### macOS
|
||||||
|
|
||||||
On macOS a [package](https://formulae.brew.sh/formula/iamb#default) is availabe in Homebrew's
|
On macOS a [package](https://formulae.brew.sh/formula/iamb#default) is availabe in Homebrew's
|
||||||
|
@ -75,6 +89,14 @@ repository. To install it simply run:
|
||||||
brew install iamb
|
brew install iamb
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### NetBSD
|
||||||
|
|
||||||
|
On NetBSD a package is available from the official repositories. To install it simply run:
|
||||||
|
|
||||||
|
```
|
||||||
|
pkgin install iamb
|
||||||
|
```
|
||||||
|
|
||||||
### Nix / NixOS (flake)
|
### Nix / NixOS (flake)
|
||||||
|
|
||||||
```
|
```
|
||||||
|
@ -97,33 +119,11 @@ A snap for Linux distributions which [support](https://snapcraft.io/docs/install
|
||||||
snap install iamb
|
snap install iamb
|
||||||
```
|
```
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
You can create a basic configuration in `$CONFIG_DIR/iamb/config.toml` that looks like:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[profiles."example.com"]
|
|
||||||
user_id = "@user:example.com"
|
|
||||||
```
|
|
||||||
|
|
||||||
If you homeserver is located on a different domain than the server part of the
|
|
||||||
`user_id` and you don't have a [`/.well-known`][well_known_entry] entry, then
|
|
||||||
you can explicitly specify the homeserver URL to use:
|
|
||||||
|
|
||||||
```toml
|
|
||||||
[profiles."example.com"]
|
|
||||||
url = "https://example.com"
|
|
||||||
user_id = "@user:example.com"
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
iamb is released under the [Apache License, Version 2.0].
|
iamb is released under the [Apache License, Version 2.0].
|
||||||
|
|
||||||
[Apache License, Version 2.0]: https://github.com/ulyssa/iamb/blob/master/LICENSE
|
[Apache License, Version 2.0]: https://github.com/ulyssa/iamb/blob/master/LICENSE
|
||||||
[client-comparison-matrix]: https://matrix.org/clients-matrix/
|
|
||||||
[crates-io-iamb]: https://crates.io/crates/iamb
|
[crates-io-iamb]: https://crates.io/crates/iamb
|
||||||
[iamb.chat]: https://iamb.chat
|
[iamb.chat]: https://iamb.chat
|
||||||
[gomuks]: https://github.com/tulir/gomuks
|
|
||||||
[weechat-matrix]: https://github.com/poljar/weechat-matrix
|
|
||||||
[well_known_entry]: https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
|
[well_known_entry]: https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue