From 61f8af9b5cdcafcab7f0c885ddfc8ab7dcd88e30 Mon Sep 17 00:00:00 2001
From: Adrian Sieber <mail@adriansieber.com>
Date: Fri, 26 Aug 2016 16:24:21 +0000
Subject: [PATCH] Add table of contents to README.md (#429)

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fa3275d..4e3d63b 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
- [![npm version](https://img.shields.io/npm/v/bunyan.svg?style=flat)](https://www.npmjs.com/package/bunyan)
+[![npm version](https://img.shields.io/npm/v/bunyan.svg?style=flat)](https://www.npmjs.com/package/bunyan)
 
 Bunyan is **a simple and fast JSON logging library** for node.js services:
 
@@ -20,6 +20,47 @@ record (see below).
 Also: log4j is way more than you need.
 
 
+## Table of Contents
+
+<!-- toc -->
+
+- [Current Status](#current-status)
+- [Installation](#installation)
+- [Features](#features)
+- [Introduction](#introduction)
+  * [Constructor API](#constructor-api)
+  * [Log Method API](#log-method-api)
+  * [CLI Usage](#cli-usage)
+  * [Streams Introduction](#streams-introduction)
+  * [log.child](#logchild)
+  * [Serializers](#serializers)
+    + [Standard Serializers](#standard-serializers)
+  * [src](#src)
+- [Levels](#levels)
+  * [Level suggestions](#level-suggestions)
+- [Log Record Fields](#log-record-fields)
+  * [Core fields](#core-fields)
+  * [Recommended/Best Practice Fields](#recommendedbest-practice-fields)
+  * [Other fields to consider](#other-fields-to-consider)
+- [Streams](#streams)
+  * [stream errors](#stream-errors)
+  * [stream type: `stream`](#stream-type-stream)
+  * [stream type: `file`](#stream-type-file)
+  * [stream type: `rotating-file`](#stream-type-rotating-file)
+  * [stream type: `raw`](#stream-type-raw)
+  * [`raw` + RingBuffer Stream](#raw--ringbuffer-stream)
+  * [third-party streams](#third-party-streams)
+- [Runtime log snooping via DTrace](#runtime-log-snooping-via-dtrace)
+  * [DTrace examples](#dtrace-examples)
+- [Runtime environments](#runtime-environments)
+  * [Browserify](#browserify)
+  * [Webpack](#webpack)
+- [Versioning](#versioning)
+- [License](#license)
+- [See Also](#see-also)
+
+<!-- tocstop -->
+
 # Current Status
 
 Solid core functionality is there. Joyent is using this for a number of