aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-07-26 12:33:34 -0400
committerZoffix Znet <cpan@zoffix.com>2016-07-26 12:33:34 -0400
commitbd1a78776278bb1c6a94cd37918296a99277319e (patch)
tree425bea8898a1c1955288575e31c9901bedd6db99 /README.md
parentbcc921c6e0f596cc3217d1e49ab9cae8c67b961a (diff)
Move README to docs
Diffstat (limited to 'README.md')
l---------[-rw-r--r--]README.md60
1 files changed, 1 insertions, 59 deletions
diff --git a/README.md b/README.md
index e28417b..0e01b43 100644..120000
--- a/README.md
+++ b/README.md
@@ -1,59 +1 @@
-[![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.
+docs/README.md \ No newline at end of file