code.ivysaur.me/nmdc-ircfrontend
1
0
Fork 0
Code Issues 9 Pull Requests Releases 7 Wiki Activity

doc: top-level README.md

Browse Source
This commit is contained in:
mappu 2019-01-07 20:01:33 +13:00
parent 4b5b334a41
commit fff9d4442e
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
_dist/README.txt → README.md
View File

@ -1,3 +1,5 @@
# nmdc-ircfrontend
An IRC protocol frontend for an NMDC server. 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. 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. 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. 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 ## Features
Tags: nmdc, AGPLv3
=FEATURES=
- Seamless roundtrip transition between NMDC `/me` and IRC `CTCP ACTION` - Seamless roundtrip transition between NMDC `/me` and IRC `CTCP ACTION`
- IRC client's "Real Name" exposed as NMDC Description - IRC client's "Real Name" exposed as NMDC Description
@ -25,9 +25,10 @@ Tags: nmdc, AGPLv3
- Multithreaded - Multithreaded
- Single binary deployment - Single binary deployment
=USAGE= ## Usage
`Usage of nmdc-ircfrontend: ```
Usage of nmdc-ircfrontend:
-autojoin -autojoin
Automatically join clients to the channel (default true) Automatically join clients to the channel (default true)
-bind string -bind string
@ -39,9 +40,10 @@ Tags: nmdc, AGPLv3
-upstream string -upstream string
Upstream NMDC/ADC server (default "127.0.0.1:411") Upstream NMDC/ADC server (default "127.0.0.1:411")
-verbose -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.* *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: Unusable:
- Rocket.chat 0.6x IRC plugin (can join room and recieve PMs after some regex tweaking) - Rocket.chat 0.6x IRC plugin (can join room and recieve PMs after some regex tweaking)
=CHANGELOG= ## Changelog
2018-03-24 1.3.0 2018-03-24 1.3.0
- Feature: Support ADC hubs - Feature: Support ADC hubs