soju/README.md

35 lines
799 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].
## 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