diff --git a/README.md b/README.md index 9035c18..367b352 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,28 @@ A universal, human-centric, replayable event emitter. [![Build Status](https://travis-ci.org/lifenautjoe/noel.svg?branch=master)](https://travis-ci.org/lifenautjoe/noel) ![Human Friendly](https://img.shields.io/badge/human-friendly-brightgreen.svg) [![Coverage Status](https://coveralls.io/repos/github/lifenautjoe/noel/badge.svg?branch=master)](https://coveralls.io/github/lifenautjoe/noel?branch=master) +## Table of Contents + +- [Motivation](#motivation) +- [Features](#features) +- [Installation](#installation) +- [Usage](#usage) + * [Creating a noel instance](#creating-a-noel-instance) + * [Emitting and listening to events](#emitting-and-listening-to-events) + * [Replaying events](#replaying-events) + * [Disabling replay](#disabling-replay) + * [Enabling replay](#enabling-replay) + * [Removing an event listener](#removing-an-event-listener) + * [Removing all event listeners](#removing-all-event-listeners) + * [Clearing an event replay buffer](#clearing-an-event-replay-buffer) + * [Clearing all events replay buffers](#clearing-all-events-replay-buffers) + * [Changing the events replay buffer size](#changing-the-events-replay-buffer-size) + * [Disabling the no event listeners warning](#disabling-the-no-event-listeners-warning) + * [Enabling the no event listeners warning](#enabling-the-no-event-listeners-warning) +- [Development](#development) + * [Clone the repository](#clone-the-repository) + * [Use npm commands](#use-npm-commands) + ## Motivation The world just like software is full of events. Sometimes these events occur while we are busy doing other things. Wouldn't it be nice to have a way to replay all events? Noel is the way.