diff options
| author | Hubert Hirtz <hubert@hirtz.pm> | 2021-11-18 17:38:38 +0100 |
|---|---|---|
| committer | Hubert Hirtz <hubert@hirtz.pm> | 2021-11-18 17:38:38 +0100 |
| commit | 2f73a2038caf50c95036937914450f3557906c0c (patch) | |
| tree | 3b2cdc5ff7a00d53d2f9e1e08a73de75e9c4f6d7 /README.md | |
| parent | Add support for the /QUERY command (diff) | |
OK GitHub: update README.MD
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 16 insertions, 9 deletions
@@ -2,25 +2,29 @@ Welcome home, desune~ - + -Works best with soju! +senpai is an IRC client that works best with bouncers: -## ... How? +- no logs are kept, +- history is fetched from the server via [CHATHISTORY], +- networks are fetched from the server via [bouncer-networks]. + +## How do I use this? ```shell mkdir -p ~/.config/senpai cat <<EOF >~/.config/senpai/senpai.yaml -addr: irc.libera.chat +addr: chat.sr.ht nick: senpai -password: "my password can't be this cute" +password: "my password can't be this cute (2010)" # alternatively, specify a command to fetch your password: # password-cmd: "gopass show irc/<username>" EOF go run ./cmd/senpai ``` -Then, type `/join #senpai` and have a chat! +Then, type `/join #senpai` on [Libera.Chat] and have a... chat! See `doc/senpai.1.scd` for more information and `doc/senpai.5.scd` for more configuration options! @@ -40,9 +44,6 @@ things out with an IRC server, then you have two options: Contributions are accepted as patches to [the mailing list][ml] and as pull requests on [Github]. -[ml]: mailto:~taiite/public-inbox@lists.sr.ht -[Github]: https://github.com/hhirtz/senpai/pulls - Browse tickets at <https://todo.sr.ht/~taiite/senpai>. ## License @@ -50,3 +51,9 @@ Browse tickets at <https://todo.sr.ht/~taiite/senpai>. This senpai is open source! Please use it under the ISC license. Copyright (C) 2021 The senpai Contributors + +[bouncer-networks]: https://git.sr.ht/~emersion/soju/tree/master/item/doc/ext/bouncer-networks.md +[CHATHISTORY]: https://ircv3.net/specs/extensions/chathistory +[Github]: https://github.com/hhirtz/senpai/pulls +[Libera.Chat]: https://libera.chat/ +[ml]: https://lists.sr.ht/~taiite/public-inbox |