Skip to content

Commit 678f431

Browse files
committed
generate docs
1 parent 03a2b7f commit 678f431

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

README.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# cache-base [![NPM version](https://img.shields.io/npm/v/cache-base.svg?style=flat)](https://www.npmjs.com/package/cache-base) [![NPM downloads](https://img.shields.io/npm/dm/cache-base.svg?style=flat)](https://npmjs.org/package/cache-base) [![Build Status](https://img.shields.io/travis/jonschlinkert/cache-base.svg?style=flat)](https://travis-ci.org/jonschlinkert/cache-base)
22

3-
> Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.
3+
Basic object cache with `get`, `set`, `del`, and `has` methods for node.js/javascript projects.
44

55
## Install
66

@@ -145,7 +145,7 @@ console.log(app.get('a'));
145145
//=> {b: ['foo', 'bar']}
146146
```
147147

148-
### [.get](index.js#L132)
148+
### [.get](index.js#L136)
149149

150150
Return the value of `key`. Dot notation may be used to get [nested property values][get-value].
151151

@@ -169,7 +169,7 @@ app.get(['a', 'b']);
169169
//=> {c: 'd'}
170170
```
171171

172-
### [.has](index.js#L159)
172+
### [.has](index.js#L163)
173173

174174
Return true if app has a stored value for `key`, false only if value is `undefined`.
175175

@@ -190,7 +190,7 @@ app.has('foo');
190190
//=> true
191191
```
192192

193-
### [.del](index.js#L187)
193+
### [.del](index.js#L191)
194194

195195
Delete one or more properties from the instance.
196196

@@ -213,7 +213,7 @@ app.del('foo');
213213
app.del(['foo', 'bar']);
214214
```
215215

216-
### [.clear](index.js#L206)
216+
### [.clear](index.js#L210)
217217

218218
Reset the entire cache to an empty object.
219219

@@ -223,7 +223,7 @@ Reset the entire cache to an empty object.
223223
app.clear();
224224
```
225225

226-
### [.visit](index.js#L223)
226+
### [.visit](index.js#L227)
227227

228228
Visit `method` over the properties in the given object, or map
229229
visit over the object-elements in an array.
@@ -247,20 +247,16 @@ You might also be interested in these projects:
247247

248248
## Contributing
249249

250+
This document was generated by [verb](https://github.com/verbose/verb), please don't edit directly. Any changes to the readme must be made in [.verb.md](.verb.md). See [Building Docs](#building-docs).
251+
250252
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/cache-base/issues/new).
251253

252254
## Building docs
253255

254256
Generate readme and API documentation with [verb](https://github.com/verbose/verb):
255257

256258
```sh
257-
$ npm install verb && npm run docs
258-
```
259-
260-
Or, if [verb](https://github.com/verbose/verb) is installed globally:
261-
262-
```sh
263-
$ verb
259+
$ npm install -g verb verb-readme-generator && verb
264260
```
265261

266262
## Running tests
@@ -285,4 +281,4 @@ Released under the [MIT license](https://github.com/jonschlinkert/cache-base/blo
285281

286282
***
287283

288-
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 21, 2016._
284+
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on May 30, 2016._

0 commit comments

Comments
 (0)