source: code/trunk/README.md@ 232

Last change on this file since 232 was 189, checked in by contact, 5 years ago

readme: advise connecting with "<username>/<network>"

This matches znc's behavior and is more consistent with the
multiple-upstream mode (where channels and nicks are suffixed with
"/<network>" as well).

File size: 829 bytes
Line 
1# soju
2
3A user-friendly IRC bouncer.
4
5- Multi-user
6- Support multiple clients for a single user, with proper backlog
7 synchronization
8- Support connecting to multiple upstream servers via a single IRC connection
9 to the bouncer
10
11## Usage
12
13 sqlite3 soju.db <schema.sql
14 go run ./cmd/sojuctl create-user <username>
15 go run ./cmd/soju
16
17Then connect with username `<username>/chat.freenode.net` and join `#soju`.
18
19See the man page at `soju.1.scd` for more information.
20
21## Contributing
22
23Send patches on the [mailing list] or on [GitHub], report bugs on the
24[issue tracker]. Discuss in #soju on Freenode.
25
26## License
27
28AGPLv3, see LICENSE.
29
30Copyright (C) 2020 Simon Ser
31
32[mailing list]: https://lists.sr.ht/~emersion/public-inbox
33[GitHub]: https://github.com/emersion/soju
34[issue tracker]: https://todo.sr.ht/~emersion/soju
Note: See TracBrowser for help on using the repository browser.