From a9f36acb688fca85e686d1c5b731024e501307e7 Mon Sep 17 00:00:00 2001 From: Zoffix Znet Date: Tue, 26 Jul 2016 12:35:16 -0400 Subject: Move README.md back to root; links in it do not work properly --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) mode change 120000 => 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md deleted file mode 120000 index 0e01b43..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e28417b --- /dev/null +++ b/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 + :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