diff options
authorZoffix Znet <cpan@zoffix.com>2016-07-26 13:37:25 -0400
committerZoffix Znet <cpan@zoffix.com>2016-07-26 13:37:25 -0400
commit74e4c7e39f8f73b0e7bef457585e6352505a355f (patch)
parenta9f36acb688fca85e686d1c5b731024e501307e7 (diff)
Add some docs
2 files changed, 99 insertions, 3 deletions
diff --git a/README.md b/README.md
index e28417b..f6271b2 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ IRC::Client - Extendable Internet Relay Chat client
use Pastebin::Shadowcat;
.run with IRC::Client.new:
- :host<localhost>
+ :host<irc.freenode.net>
:channels<#perl6bot #zofbot>
@@ -34,7 +34,7 @@ and output post-processing.
* [Basics Tutorial](docs/01-basics.md)
-* [Event reference](docs/01-event-reference.md)
+* [Event reference](docs/02-event-reference.md)
diff --git a/docs/01-basics.md b/docs/01-basics.md
index 2c72817..091af42 100644
--- a/docs/01-basics.md
+++ b/docs/01-basics.md
@@ -1 +1,97 @@
-[[back to main docs]](README.md#documentation-map)
+[[back to main docs]](../README.md#documentation-map)
+# Basics Tutorial
+This tutorial covers basic usage of `IRC::Client`, without going into
+[all of the supported events](02-event-reference.md) or describing
+[all of the methods](03-method-reference.md) or [available Message
+Objects](04-message-objects.md). This should be enough
+if you're just bringing some functionality using IRC as your interface, rather
+than making, say, a full-featured IRC client.
+## Blog Tutorial
+There exists a blog post describing this bot and showcasing some of the
+more advanced features. You can find it at [*yet to be published*](#).
+## Subscribing to Events
+All of the functionality is implemented as "plugins," which are passed to
+the `:plugins` attribute. Plugins are just regular classes, altough they can
+do the `IRC::Client::Plugin` role to obtain extra functionality.
+To subscribe to subscribe to one of [the events](02-event-reference.md), simply
+create a method with event's name in your class. The tutorial will use the
+`irc-to-me` event, which is a convenience event fired when the bot is addressed
+in-channel or someone sends it a notice or a private message.
+### Event Handler Input
+The event handlers receive one positional argument, which is an object
+that does `IRC::Client::Message` role. The actual object received depends
+on the event that triggered the handler. For example, the `irc-to-me` can
+receive these message objects:
+ IRC::Client::Message::Privmsg::Me
+ IRC::Client::Message::Privmsg::Channel
+ IRC::Client::Message::Notice::Me
+ IRC::Client::Message::Notice::Channel
+While message objects differ in methods they offer, all of the above do have
+a `.text` attribute and stringify to its value. This means we can add a type
+constraint on it without having to explicitly call it:
+ method irc-to-me ($e where /'bot command'/) { 'Do things here!'; }
+## Responding to Events
+Channel messages, private messages, and notices can be replied to. Their
+message objects have a `.reply` method you can call to send a reply to the
+message's sender, however it's easier to just return a value from your method
+handler, which will automatically call `.reply` on the message object for you.
+Returning a value from your event handler singnals to the Client Object that
+it handled the event and no other plugins or event handlers should be tried.
+Your plugin can do the `IRC::Client::Plugin` role (automatically exported
+when you `use IRC::Client`), which provides `$.NEXT` attribute. The value
+of that attribute is special and returning it signals the Client Object
+that your event handler did **not** handle the event and other plugins and
+event handlers should be tried.
+Here are the things your event handler can return:
+* Value of `$.NEXT`: pass the event to next plugin or event handler than can
+handle it
+* `Nil`: do not reply to the message, but do not pass the event to any other
+event handler; we handled it
+* `Promise`: when the Promise is `.kept`, use its value for the .reply, unless
+it's a `Nil`. **Note:** you cannot return `$.NEXT` here.
+* Any other value: it will be given to message object's `.reply` method if
+it has one, or ignored if it doesn't. For `irc-to-me` message objects, this
+means the value will be sent back to the sender of the original message
+### Example: Echo Bot
+In this example, we subscribe to the `irc-to-me` event and respond by returning
+the original message, prefixed with `You said `.
+ use IRC::Client;
+ .run with IRC::Client.new:
+ :host<irc.freenode.net>
+ :channels<#perl6bot #zofbot>
+ :debug
+ :plugins(
+ class { method irc-to-me ($e) { "You said $e.text()"} }
+ )
+## Generating Messages
+If your plugin needs to generate messages instead of merely responding to
+commands, you can use the Client Object's `.send` method.