source: code/trunk/README.md@ 286

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

readme: fix ref to manpage

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