soju/README.md
Simon Ser 8e6eb18d09
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).
2020-03-31 18:41:14 +02:00

35 lines
829 B
Markdown

# soju
A user-friendly IRC bouncer.
- Multi-user
- Support multiple clients for a single user, with proper backlog
synchronization
- Support connecting to multiple upstream servers via a single IRC connection
to the bouncer
## Usage
sqlite3 soju.db <schema.sql
go run ./cmd/sojuctl create-user <username>
go run ./cmd/soju
Then connect with username `<username>/chat.freenode.net` and join `#soju`.
See the man page at `soju.1.scd` for more information.
## Contributing
Send patches on the [mailing list] or on [GitHub], report bugs on the
[issue tracker]. Discuss in #soju on Freenode.
## License
AGPLv3, see LICENSE.
Copyright (C) 2020 Simon Ser
[mailing list]: https://lists.sr.ht/~emersion/public-inbox
[GitHub]: https://github.com/emersion/soju
[issue tracker]: https://todo.sr.ht/~emersion/soju