From 5e2839eb390258bbfb25a5f04909b23ebc78fbdc Mon Sep 17 00:00:00 2001 From: Les De Ridder Date: Fri, 17 Mar 2017 21:23:36 +0100 Subject: [PATCH] Add readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..80ba373 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# salty-ircd + +salty-ircd is an [Internet Relay Chat](https://en.wikipedia.org/wiki/Internet_Relay_Chat) daemon written in [D](https://dlang.org/). + +## Goals +The main goals of salty-ircd are strict RFC compliance and security. + +### RFC compliance +salty-ircd aims to be fully compliant with the IRC RFCs, specifically [RFC 1459](https://tools.ietf.org/html/rfc1459), [RFC 2811](https://tools.ietf.org/html/rfc2811), [RFC 2811](https://tools.ietf.org/html/rfc2812), and [RFC 2813](https://tools.ietf.org/html/rfc2813) (planned). + +Any features breaking RFC compliance will be made available through compile-time options. + +### Security + * salty-ircd will require TLS for all connections. An exception could be made to allow hosting a Tor hidden service. + * salty-ircd will require TLS client certificates for authentication. + +## License +The source code for salty-ircd is licensed under the [University of Illinois/NCSA Open Source License](LICENSE).