From 92e69fbe171fea012c4e374d332768f1ef2f4173 Mon Sep 17 00:00:00 2001
From: Zoffix Znet <cpan@zoffix.com>
Date: Mon, 21 Dec 2015 09:27:05 -0500
Subject: Add TOC

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index feeb982..809b418 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,56 @@ IRC::Client - Extendable Internet Relay Chat client
     ).run;
 ```
 
+# 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)
+- [DESCRIPTION](#description)
+- [BLEED BRANCH](#bleed-branch)
+- [METHODS](#methods)
+    - [`new`](#new)
+        - [`debug`](#debug)
+        - [`host`](#host)
+        - [`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-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)
+
 ## Custom plugins
 
 ### Basic response to an IRC command:
-- 
cgit v1.1