commit 2f73a20

Hubert Hirtz  ·  2021-11-18 16:38:38 +0000 UTC
parent 0359bd5
OK GitHub: update README.MD
1 files changed,  +16, -9
+16, -9
 1@@ -2,25 +2,29 @@
 2 
 3 Welcome home, desune~
 4 
 5-![a screenshot of your senpai!](https://ellidri.org/senpai/screen.png)
 6+![a screenshot of your senpai feat. simon!](https://taiite.srht.site/senpai.png)
 7 
 8-Works best with soju!
 9+senpai is an IRC client that works best with bouncers:
10 
11-## ... How?
12+- no logs are kept,
13+- history is fetched from the server via [CHATHISTORY],
14+- networks are fetched from the server via [bouncer-networks].
15+
16+## How do I use this?
17 
18 ```shell
19 mkdir -p ~/.config/senpai
20 cat <<EOF >~/.config/senpai/senpai.yaml
21-addr: irc.libera.chat
22+addr: chat.sr.ht
23 nick: senpai
24-password: "my password can't be this cute"
25+password: "my password can't be this cute (2010)"
26 # alternatively, specify a command to fetch your password:
27 # password-cmd: "gopass show irc/<username>"
28 EOF
29 go run ./cmd/senpai
30 ```
31 
32-Then, type `/join #senpai` and have a chat!
33+Then, type `/join #senpai` on [Libera.Chat] and have a... chat!
34 
35 See `doc/senpai.1.scd` for more information and `doc/senpai.5.scd` for more
36 configuration options!
37@@ -40,9 +44,6 @@ things out with an IRC server, then you have two options:
38 Contributions are accepted as patches to [the mailing list][ml] and as pull
39 requests on [Github].
40 
41-[ml]: mailto:~taiite/public-inbox@lists.sr.ht
42-[Github]: https://github.com/hhirtz/senpai/pulls
43-
44 Browse tickets at <https://todo.sr.ht/~taiite/senpai>.
45 
46 ## License
47@@ -50,3 +51,9 @@ Browse tickets at <https://todo.sr.ht/~taiite/senpai>.
48 This senpai is open source! Please use it under the ISC license.
49 
50 Copyright (C) 2021 The senpai Contributors
51+
52+[bouncer-networks]: https://git.sr.ht/~emersion/soju/tree/master/item/doc/ext/bouncer-networks.md
53+[CHATHISTORY]: https://ircv3.net/specs/extensions/chathistory
54+[Github]: https://github.com/hhirtz/senpai/pulls
55+[Libera.Chat]: https://libera.chat/
56+[ml]: https://lists.sr.ht/~taiite/public-inbox