source: code/trunk/README.md@ 201

Last change on this file since 201 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
RevLine 
[98]1# soju
[2]2
[53]3A user-friendly IRC bouncer.
[2]4
[53]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
[78]11## Usage
12
[98]13 sqlite3 soju.db <schema.sql
[100]14 go run ./cmd/sojuctl create-user <username>
[98]15 go run ./cmd/soju
[78]16
[189]17Then connect with username `<username>/chat.freenode.net` and join `#soju`.
[91]18
[123]19See the man page at `soju.1.scd` for more information.
20
[53]21## Contributing
22
[123]23Send patches on the [mailing list] or on [GitHub], report bugs on the
[130]24[issue tracker]. Discuss in #soju on Freenode.
[53]25
[2]26## License
27
[52]28AGPLv3, see LICENSE.
29
30Copyright (C) 2020 Simon Ser
[53]31
32[mailing list]: https://lists.sr.ht/~emersion/public-inbox
[123]33[GitHub]: https://github.com/emersion/soju
[98]34[issue tracker]: https://todo.sr.ht/~emersion/soju
Note: See TracBrowser for help on using the repository browser.