summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Spek <p.spek@tyil.nl>2018-01-29 08:17:10 +0100
committerPatrick Spek <p.spek@tyil.nl>2018-01-29 08:19:29 +0100
commitf1956c9ac132ad24080d9bb2ea2fe9219a0ecbc3 (patch)
tree671a06f17610bf27f9e407f8aab15a7fd5d04507
parent9ba21719f053b333ea605e6d1035111a38df75e9 (diff)
downloadIRC::Client::Plugin::NickServ-f1956c9ac132ad24080d9bb2ea2fe9219a0ecbc3.tar.gz
IRC::Client::Plugin::NickServ-f1956c9ac132ad24080d9bb2ea2fe9219a0ecbc3.tar.bz2
Add readme
-rw-r--r--readme.adoc44
1 files changed, 44 insertions, 0 deletions
diff --git a/readme.adoc b/readme.adoc
new file mode 100644
index 0000000..e0570c6
--- /dev/null
+++ b/readme.adoc
@@ -0,0 +1,44 @@
+= `IRC::Client::Plugin::NickServ`
+
+Handle NickServ interaction for `IRC::Client` projects. Currently only does
+identification with NickServ.
+
+== Usage
+Install this module through the Perl 6 package manager
+(https://github.com/ugexe/zef[`zef`]):
+
+[source,sh]
+----
+zef install IRC::Client::Plugin::NickServ
+----
+
+Next, enable it as a plugin in your `IRC::Client` project:
+
+[source,perl6]
+----
+use Config;
+use IRC::Client;
+use IRC::Client::Plugin::NickServ;
+
+sub MAIN
+{
+ my Config $config = Config.new;
+
+ $config.read: %(
+ nickserv => %(
+ nickname => "testbot",
+ password => "testpassword",
+ ),
+ );
+
+ .run with IRC::Client.new(
+ :nick($config<nickserv><nickname>),
+ :plugins(
+ IRC::Client::Plugin::NickServ.new(:$config)
+ )
+ );
+}
+----
+
+== License
+This sourcecode is distributed under the GPLv3 license.