lighter-lru-cache/README.md

A lightweight JavaScript LRU cache.

# lighter-lru-cache
[![Chat](https://badges.gitter.im/chat.svg)](//gitter.im/lighterio/public)
[![Version](https://img.shields.io/npm/v/lighter-lru-cache.svg)](//www.npmjs.com/package/lighter-lru-cache)
[![Downloads](https://img.shields.io/npm/dm/lighter-lru-cache.svg)](//www.npmjs.com/package/lighter-lru-cache)
[![Build](https://img.shields.io/travis/lighterio/lighter-lru-cache.svg)](//travis-ci.org/lighterio/lighter-lru-cache)
[![Coverage](https://img.shields.io/coveralls/lighterio/lighter-lru-cache/master.svg)](//coveralls.io/r/lighterio/lighter-lru-cache)
[![Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](//www.npmjs.com/package/standard)

The `lighter-lru-cache` module is a lightweight LRU cache.


## Installation

From your project directory, install and save as a dependency:
```bash
npm install --save lighter-lru-cache
```


## API

For now, please see the [source](https://github.com/lighterio/lighter-lru-cache/blob/master/lighter-lru-cache.js).


## Examples

For now, please see the [tests](https://github.com/lighterio/lighter-lru-cache/blob/master/test).


## More on lighter-lru-cache...
* [Contributing](//github.com/lighterio/lighter-lru-cache/blob/master/CONTRIBUTING.md)
* [License (ISC)](//github.com/lighterio/lighter-lru-cache/blob/master/LICENSE.md)
* [Change Log](//github.com/lighterio/lighter-lru-cache/blob/master/CHANGELOG.md)
* [Roadmap](//github.com/lighterio/lighter-lru-cache/blob/master/ROADMAP.md)