aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-07-26 12:35:16 -0400
committerZoffix Znet <cpan@zoffix.com>2016-07-26 12:35:16 -0400
commita9f36acb688fca85e686d1c5b731024e501307e7 (patch)
treef760162e9c1d9a6fe6facc1aeeab3a7dbf206cc1 /README.md
parentbd1a78776278bb1c6a94cd37918296a99277319e (diff)
Move README.md back to root; links in it do not work properly
Diffstat (limited to 'README.md')
-rw-r--r--[l---------]README.md60
1 files changed, 59 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0e01b43..e28417b 120000..100644
--- a/README.md
+++ b/README.md
@@ -1 +1,59 @@
-docs/README.md \ No newline at end of file
+[![Build Status](https://travis-ci.org/zoffixznet/perl6-IRC-Client.svg)](https://travis-ci.org/zoffixznet/perl6-IRC-Client)
+
+# NAME
+
+IRC::Client - Extendable Internet Relay Chat client
+
+# SYNOPSIS
+
+```perl6
+ use IRC::Client;
+ use Pastebin::Shadowcat;
+
+ .run with IRC::Client.new:
+ :host<localhost>
+ :channels<#perl6bot #zofbot>
+ :debug
+ :plugins(
+ class { method irc-to-me ($ where /hello/) { 'Hello to you too!'} }
+ )
+ :filters(
+ -> $text where .chars > 200 {
+ 'The output is too large to show here. See: '
+ ~ Pastebin::Shadowcat.new.paste: $text;
+ }
+ );
+```
+
+# DESCRIPTION
+
+The module provides the means to create clients to communicate with
+IRC (Internet Relay Chat) servers. Has support for non-blocking responses
+and output post-processing.
+
+# DOCUMENTATION MAP
+
+* [Basics Tutorial](docs/01-basics.md)
+* [Event reference](docs/01-event-reference.md)
+
+---
+
+# REPOSITORY
+
+Fork this module on GitHub:
+https://github.com/zoffixznet/perl6-IRC-Client
+
+# BUGS
+
+To report bugs or request features, please use
+https://github.com/zoffixznet/perl6-IRC-Client/issues
+
+# AUTHOR
+
+Zoffix Znet (http://zoffix.com/)
+
+# LICENSE
+
+You can use and distribute this module under the terms of the
+The Artistic License 2.0. See the `LICENSE` file included in this
+distribution for complete details.