From fff9d4442e9e512f49cd198eae82984f238d42f0 Mon Sep 17 00:00:00 2001 From: mappu Date: Mon, 7 Jan 2019 20:01:33 +1300 Subject: [PATCH] doc: top-level README.md --- _dist/README.txt => README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) rename _dist/README.txt => README.md (96%) diff --git a/_dist/README.txt b/README.md similarity index 96% rename from _dist/README.txt rename to README.md index 4761737..046131c 100644 --- a/_dist/README.txt +++ b/README.md @@ -1,3 +1,5 @@ +# nmdc-ircfrontend + An IRC protocol frontend for an NMDC server. This program 'wraps' an NMDC server to make it available to IRC clients. It implements the IRC server protocol, but is not itself an IRC server, deferring to the upstream NMDC server in all salient cases. From a layering perspective it occupies the same position as the web interface. @@ -6,13 +8,11 @@ The intent of this project is to expand client library and application support o TLS (SSL) support is not integrated. To host the IRC frontend over TLS, please use a reverse proxy in much the same manner as for NMDCS. +## License + This program uses some code from the AGPLv3 project https://github.com/eXeC64/Rosella , from which it inherits the Affero GPLv3 license. Anyone hosting a modified version of this software is required to release their changes under the terms of the AGPLv3. -Written in golang - -Tags: nmdc, AGPLv3 - -=FEATURES= +## Features - Seamless roundtrip transition between NMDC `/me` and IRC `CTCP ACTION` - IRC client's "Real Name" exposed as NMDC Description @@ -25,9 +25,10 @@ Tags: nmdc, AGPLv3 - Multithreaded - Single binary deployment -=USAGE= +## Usage -`Usage of nmdc-ircfrontend: +``` +Usage of nmdc-ircfrontend: -autojoin Automatically join clients to the channel (default true) -bind string @@ -39,9 +40,10 @@ Tags: nmdc, AGPLv3 -upstream string Upstream NMDC/ADC server (default "127.0.0.1:411") -verbose - Display debugging information` + Display debugging information +``` -=COMPATIBILITY= +## Compatibility *This section was last updated on or around the release of 1.3.0. Current compatibility may differ.* @@ -67,7 +69,7 @@ Tested working: Unusable: - Rocket.chat 0.6x IRC plugin (can join room and recieve PMs after some regex tweaking) -=CHANGELOG= +## Changelog 2018-03-24 1.3.0 - Feature: Support ADC hubs