Skip to content

Commit

Permalink
Release v0.0.10
Browse files Browse the repository at this point in the history
  • Loading branch information
ulyssa committed Aug 21, 2024
1 parent 480888a commit bf92104
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "iamb"
version = "0.0.10-alpha.1"
version = "0.0.10"
edition = "2018"
authors = ["Ulyssa <[email protected]>"]
repository = "https://github.com/ulyssa/iamb"
Expand Down
64 changes: 32 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -31,14 +32,37 @@ _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:

```
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
Expand All @@ -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:
Expand All @@ -58,21 +80,21 @@ On FreeBSD a package is available from the official repositories. To install it
pkg install iamb
```

### NetBSD
### macOS

On NetBSD a package is available from the official repositories. To install it simply run:
On macOS a [package](https://formulae.brew.sh/formula/iamb#default) is availabe in Homebrew's
repository. To install it simply run:

```
pkgin install iamb
brew install iamb
```

### macOS
### NetBSD

On macOS a [package](https://formulae.brew.sh/formula/iamb#default) is availabe in Homebrew's
repository. To install it simply run:
On NetBSD a package is available from the official repositories. To install it simply run:

```
brew install iamb
pkgin install iamb
```

### Nix / NixOS (flake)
Expand All @@ -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

0 comments on commit bf92104

Please sign in to comment.