diff --git a/README.md b/README.md new file mode 100644 index 0000000..352fe52 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# FerretIRC - Client Library + +ferretirc-client v0.1.2 + +[Maven Repo](https://central.sonatype.com/artifact/com.shr4pnel/libferretirc) + +An asynchronous, Kotlin based library for communication with IRC servers. + +FerretIRC is actively in development, so some features have not yet been implemented. I am aiming for [RFC 2812](https://www.rfc-editor.org/info/rfc2812/) compliance, whilst also adopting modern standards created by server vendors as defined in [ircdocs](https://modern.ircdocs.horse/). + +When these are compatible, IRCv3 features will follow, e.g. SASL authentication, tag support, multiprefix etc. + +## Dependencies + +- ngircd (this is inflexible as it has no windows builds, will add more IRCDs for testing later) +- sed +- ts (from moreutils) + +