From bd1a78776278bb1c6a94cd37918296a99277319e Mon Sep 17 00:00:00 2001
From: Zoffix Znet <cpan@zoffix.com>
Date: Tue, 26 Jul 2016 12:33:34 -0400
Subject: Move README to docs

---
 docs/01-basics.md |  1 +
 docs/README.md    | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 docs/01-basics.md
 create mode 100644 docs/README.md

(limited to 'docs')

diff --git a/docs/01-basics.md b/docs/01-basics.md
new file mode 100644
index 0000000..2c72817
--- /dev/null
+++ b/docs/01-basics.md
@@ -0,0 +1 @@
+[[back to main docs]](README.md#documentation-map)
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..e28417b
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,59 @@
+[![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.
-- 
cgit v1.1