source: code/trunk/README.md@ 280

Last change on this file since 280 was 265, checked in by contact, 5 years ago

readme: fix ref to manpage

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