From 6d08e0b953b4864ce076b3bb400150e6029defea Mon Sep 17 00:00:00 2001 From: James Lu Date: Sat, 17 Feb 2018 00:48:54 -0800 Subject: [PATCH] docs: various fixes pointed out by @MrBenC - Clarify the project's goals of being an IRC services *framework* - Briefly mention in the FAQ that the relay plugin is needed for...well, relay! [skip ci] (cherry picked from commit 484822e5d793ebb0d565a4b96cb2005dc630dc72) --- README.md | 2 +- docs/faq.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5eea191..52735a7 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ PyLink is an extensible, plugin-based IRC services framework written in Python. 1) a replacement for the now-defunct Janus. -2) a versatile framework and gateway to IRC. +2) a versatile framework for developing IRC services. PyLink and any bundled software are licensed under the Mozilla Public License, version 2.0 ([LICENSE.MPL2](LICENSE.MPL2)). The corresponding documentation in the [docs/](docs/) folder is licensed under the Creative Attribution-ShareAlike 4.0 International License. ([LICENSE.CC-BY-SA-4.0](LICENSE.CC-BY-SA-4.0)) diff --git a/docs/faq.md b/docs/faq.md index 36f36f9..ade697e 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -62,7 +62,7 @@ PyLink does not support inbound connections - much like regular services such as ### Does everyone need to install PyLink Relay for it to work? -**No!** Only the PyLink administrator needs to host a PyLink instance, as each can connect to multiple networks. Everyone else only needs to add a link block on their IRCd. +**No!** Only the PyLink administrator needs to host a PyLink instance with the `relay` plugin loaded, as each instance can connect to multiple networks. Everyone else only needs to add a link block on their IRCd. InterJanus-style links between PyLink daemons are not supported yet; see https://github.com/GLolol/PyLink/issues/99 for any progress regarding that.