diff --git a/.verb.md b/.verb.md index 3cf00d8..c14fdce 100644 --- a/.verb.md +++ b/.verb.md @@ -4,6 +4,9 @@ [![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] +## Table of Contents + + ## Install ``` @@ -17,6 +20,7 @@ npm i {%= name %} --save const readdir = require('{%= name %}') ``` +## API {%= apidocs('index.js') %} {% if (verb.related && verb.related.list && verb.related.list.length) { %} diff --git a/README.md b/README.md index 42a4631..2d90384 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ [![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] +## Table of Contents +- [Install](#install) +- [Usage](#usage) +- [API](#api) + * [CreateReaddirStream](#createreaddirstream) + * [.use](#use) + * [.createReaddirStream](#createreaddirstream) +- [Related](#related) +- [Contributing](#contributing) + ## Install ``` @@ -17,6 +27,8 @@ npm i create-readdir-stream --save const readdir = require('create-readdir-stream') ``` +## API + ### [CreateReaddirStream](index.js#L32) > Initialize `CreateReaddirStream` with default `options`. diff --git a/package.json b/package.json index f324fe0..5b02db8 100644 --- a/package.json +++ b/package.json @@ -75,7 +75,11 @@ }, "verb": { "run": true, - "toc": false, + "toc": { + "render": true, + "method": "preWrite", + "maxdepth": 4 + }, "layout": "empty", "tasks": [ "readme" @@ -106,4 +110,4 @@ "reflinks": true } } -} \ No newline at end of file +}