diff --git a/Cargo.lock b/Cargo.lock index 65aa3a7..afa92c9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2046,7 +2046,7 @@ dependencies = [ [[package]] name = "iamb" -version = "0.0.10-alpha.1" +version = "0.0.10" dependencies = [ "anyhow", "bitflags 2.5.0", diff --git a/Cargo.toml b/Cargo.toml index a4dce2f..ab77424 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "iamb" -version = "0.0.10-alpha.1" +version = "0.0.10" edition = "2018" authors = ["Ulyssa "] repository = "https://github.com/ulyssa/iamb" diff --git a/README.md b/README.md index 23f0547..135f640 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ - 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 - Notifications via terminal bell or desktop environment +- Send Markdown, HTML or plaintext messages - Creating, joining, and leaving rooms - Sending and accepting room invitations - 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 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: @@ -39,6 +59,10 @@ Install Rust (1.70.0 or above) and Cargo, and then run: cargo install --locked iamb ``` +See [Configuration](#configuration) for getting a profile set up. + +## Installation (via package managers) + ### Arch Linux 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 ``` -See [Configuration](#configuration) for getting a profile set up. - ### FreeBSD 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 ``` -### NetBSD - -On NetBSD a package is available from the official repositories. To install it simply run: - -``` -pkgin install iamb -``` - ### macOS 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 ``` +### NetBSD + +On NetBSD a package is available from the official repositories. To install it simply run: + +``` +pkgin install iamb +``` + ### Nix / NixOS (flake) ``` @@ -97,33 +119,11 @@ A snap for Linux distributions which [support](https://snapcraft.io/docs/install 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 iamb is released under the [Apache License, Version 2.0]. [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 [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