aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZoffix Znet <cpan@zoffix.com>2016-01-01 09:03:35 -0500
committerZoffix Znet <cpan@zoffix.com>2016-01-01 09:03:35 -0500
commitedad3021f06d71ef538ab3993f2e6302117f288f (patch)
tree78ac5388bf100de27891e06fb02525f13ca0f35f /README.md
parentb05080f31b46167d74eedbcfead35efa67b56f51 (diff)
Move TOC closer to top of page
Diffstat (limited to 'README.md')
-rw-r--r--README.md108
1 files changed, 54 insertions, 54 deletions
diff --git a/README.md b/README.md
index 5cc3513..305d0a5 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,60 @@
IRC::Client - Extendable Internet Relay Chat client
+# TABLE OF CONTENTS
+- [NAME](#name)
+- [SYNOPSIS](#synopsis)
+ - [Client script](#client-script)
+ - [Custom plugins](#custom-plugins)
+ - [Basic response to an IRC command:](#basic-response-to-an-irc-command)
+ - [More involved handling](#more-involved-handling)
+- [TABLE OF CONTENTS](#table-of-contents)
+- [DESCRIPTION](#description)
+- [BLEED BRANCH](#bleed-branch)
+- [METHODS](#methods)
+ - [`new`](#new)
+ - [`debug`](#debug)
+ - [`host`](#host)
+ - [`password`](#password)
+ - [`port`](#port)
+ - [`nick`](#nick)
+ - [`username`](#username)
+ - [`userhost`](#userhost)
+ - [`userreal`](#userreal)
+ - [`channels`](#channels)
+ - [`plugins`](#plugins)
+ - [`plugins-essential`](#plugins-essential)
+ - [`run`](#run)
+- [METHODS FOR PLUGINS](#methods-for-plugins)
+ - [`.ssay`](#ssay)
+ - [`.privmsg`](#privmsg)
+- [INCLUDED PLUGINS](#included-plugins)
+ - [IRC::Client::Plugin::Debugger](#ircclientplugindebugger)
+ - [IRC::Client::Plugin::PingPong](#ircclientpluginpingpong)
+- [EXTENDING IRC::Client / WRITING YOUR OWN PLUGINS](#extending-ircclient--writing-your-own-plugins)
+ - [Overview of the plugin system](#overview-of-the-plugin-system)
+ - [Return value constants](#return-value-constants)
+ - [`IRC_HANDLED`](#irc_handled)
+ - [`IRC_NOT_HANDLED`](#irc_not_handled)
+ - [Subscribing to IRC events](#subscribing-to-irc-events)
+ - [Standard IRC commands](#standard-irc-commands)
+ - [Special Events](#special-events)
+ - [`irc-start-up`](#irc-start-up)
+ - [`irc-connected`](#irc-connected)
+ - [`irc-all-events`](#irc-all-events)
+ - [`irc-privmsg-me`](#irc-privmsg-me)
+ - [`irc-notice-me`](#irc-notice-me)
+ - [`irc-unhandled`](#irc-unhandled)
+ - [Contents of the parsed IRC message](#contents-of-the-parsed-irc-message)
+ - [`command`](#command)
+ - [`params`](#params)
+ - [`pipe`](#pipe)
+ - [`who`](#who)
+- [REPOSITORY](#repository)
+- [BUGS](#bugs)
+- [AUTHOR](#author)
+- [LICENSE](#license)
+
# SYNOPSIS
## Client script
@@ -63,60 +117,6 @@ method irc-all-events ($irc, $e) {
```
-# TABLE OF CONTENTS
-- [NAME](#name)
-- [SYNOPSIS](#synopsis)
- - [Client script](#client-script)
- - [Custom plugins](#custom-plugins)
- - [Basic response to an IRC command:](#basic-response-to-an-irc-command)
- - [More involved handling](#more-involved-handling)
-- [TABLE OF CONTENTS](#table-of-contents)
-- [DESCRIPTION](#description)
-- [BLEED BRANCH](#bleed-branch)
-- [METHODS](#methods)
- - [`new`](#new)
- - [`debug`](#debug)
- - [`host`](#host)
- - [`password`](#password)
- - [`port`](#port)
- - [`nick`](#nick)
- - [`username`](#username)
- - [`userhost`](#userhost)
- - [`userreal`](#userreal)
- - [`channels`](#channels)
- - [`plugins`](#plugins)
- - [`plugins-essential`](#plugins-essential)
- - [`run`](#run)
-- [METHODS FOR PLUGINS](#methods-for-plugins)
- - [`.ssay`](#ssay)
- - [`.privmsg`](#privmsg)
-- [INCLUDED PLUGINS](#included-plugins)
- - [IRC::Client::Plugin::Debugger](#ircclientplugindebugger)
- - [IRC::Client::Plugin::PingPong](#ircclientpluginpingpong)
-- [EXTENDING IRC::Client / WRITING YOUR OWN PLUGINS](#extending-ircclient--writing-your-own-plugins)
- - [Overview of the plugin system](#overview-of-the-plugin-system)
- - [Return value constants](#return-value-constants)
- - [`IRC_HANDLED`](#irc_handled)
- - [`IRC_NOT_HANDLED`](#irc_not_handled)
- - [Subscribing to IRC events](#subscribing-to-irc-events)
- - [Standard IRC commands](#standard-irc-commands)
- - [Special Events](#special-events)
- - [`irc-start-up`](#irc-start-up)
- - [`irc-connected`](#irc-connected)
- - [`irc-all-events`](#irc-all-events)
- - [`irc-privmsg-me`](#irc-privmsg-me)
- - [`irc-notice-me`](#irc-notice-me)
- - [`irc-unhandled`](#irc-unhandled)
- - [Contents of the parsed IRC message](#contents-of-the-parsed-irc-message)
- - [`command`](#command)
- - [`params`](#params)
- - [`pipe`](#pipe)
- - [`who`](#who)
-- [REPOSITORY](#repository)
-- [BUGS](#bugs)
-- [AUTHOR](#author)
-- [LICENSE](#license)
-
# DESCRIPTION
***Note: this is a preview dev release. Things might change and new things