Skip to content

Commit

Permalink
Updated .travis.yml and README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jmdobry committed Jun 16, 2013
1 parent 5965937 commit 9ce0d96
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ node_js:
before_script:
- export DISPLAY=:99.0
- sh -e /etc/init.d/xvfb start
script: "npm test_travis"
script: "npm run-script test_travis"
53 changes: 31 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,30 @@
angular-cache (0.7.2 - Alpha)
===============
##### angular-cache is a caching system that improves upon the capabilities of the $cacheFactory provided by AngularJS. With angular-cache your caches can periodically clear themselves and flush items that have expired.
angular-cache is a caching system that improves upon the capabilities of the $cacheFactory provided by AngularJS. With angular-cache your caches can periodically clear themselves and flush items that have expired.

##### The goal of the project is to solve a general problem, not satisfy a specific scenario.
The goal of the project is to solve a general problem, not satisfy a specific scenario.

## Table of Contents
- [Features](#features)
- [Demo](#demo)
- [Status](#status)
- [Download](#download)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
### Table of Contents
1. [Features](#features)
2. [Demo](#demo)
3. [Status](#status)
4. [Download](#download)
5. [Usage](#usage)
6. [Roadmap](#roadmap)
7. [Contributing](#contributing)
8. [License](#license)

<a name='features'></a>
## Features
##### Capacity (comes with $cacheFactory)
Set maximum capacity on a cache, turning it into an LRU cache.
##### MaxAge (added by angular-cache)
Set a default maximum lifetime on all items added to the cache. They will be removed when they expire. Can be configured on a per-item basis for greater specificity.
##### CacheFlushInterval (added by angular-cache)
Set the cache to periodically clear itself.
These are in addition to what Angular's $cacheFactory provides.
#### AngularCache
- option: `maxAge` (`AngularCache.put()`): Set a default maximum lifetime on the item being added to the cache. It will be removed when it expires.

#### $angularCacheFactory
- option: `maxAge` (`$angularCacheFactory()`): Set a default maximum lifetime on all items added to the cache. They will be removed when they expire. Can be configured on a per-item basis for greater specificity.
- option: `cacheFlushInterval` (`$angularCacheFactory()`): Set the cache to periodically clear itself.
- `$angularCacheFactory.keySet()`: Return the set of keys associated with all current caches owned by $angularCacheFactory.
- `$angularCacheFactory.keys()`: Return an array of the keys associated with all current caches owned by $angularCacheFactory.

<a name='demo'></a>
## Demo
Expand All @@ -34,14 +37,19 @@ Set the cache to periodically clear itself.
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| 0.7.2 | [master](https://github.com/jmdobry/angular-cache) | [![Build Status](https://travis-ci.org/jmdobry/angular-cache.png?branch=master)](https://travis-ci.org/jmdobry/angular-cache) | [Test Coverage](http://jmdobry.github.io/angular-cache/coverage/) |
| 0.7.2 | [develop](https://github.com/jmdobry/angular-cache/tree/develop) | [![Build Status](https://travis-ci.org/jmdobry/angular-cache.png?branch=develop)](https://travis-ci.org/jmdobry/angular-cache) | |
| 0.7.2 | all | [![Build Status](https://drone.io/github.com/jmdobry/angular-cache/status.png)](https://drone.io/github.com/jmdobry/angular-cache/latest)
| 0.7.2 | [all](https://drone.io/github.com/jmdobry/angular-cache) | [![Build Status](https://drone.io/github.com/jmdobry/angular-cache/status.png)](https://drone.io/github.com/jmdobry/angular-cache/latest)

<a name='download'></a>
## Download
| Type | File | Size |
| ------------- | ----------------------------------------------------------------------------------------------------------------- | ------- |
| Production | [angular-cache-0.7.2.min.js](https://raw.github.com/jmdobry/angular-cache/master/dist/angular-cache-0.7.2.min.js) | 2.41 KB |
| Development | [angular-cache-0.7.2.js](https://raw.github.com/jmdobry/angular-cache/master/dist/angular-cache-0.7.2.js) | 22.1 KB |
#### [All Downloads](https://drone.io/github.com/jmdobry/angular-cache/files) (at drone.io)

or

#### Latest Stable Version
| Type | From drone.io | From raw.github.com | Size |
| ------------- | ----------------- | ------------------- | ---- |
| Production | [angular-cache-0.7.2.min.js](https://drone.io/github.com/jmdobry/angular-cache/files/dist/angular-cache-0.7.2.min.js) | [angular-cache-0.7.2.min.js](https://raw.github.com/jmdobry/angular-cache/master/dist/angular-cache-0.7.2.min.js) | 2.41 KB |
| Development | [angular-cache-0.7.2.js](https://drone.io/github.com/jmdobry/angular-cache/files/dist/angular-cache-0.7.2.js) | [angular-cache-0.7.2.js](https://raw.github.com/jmdobry/angular-cache/master/dist/angular-cache-0.7.2.js) | 22.1 KB |

<a name='usage'></a>
## Usage
Expand Down Expand Up @@ -196,6 +204,7 @@ See [Cache#info](http://jmdobry.github.io/angular-cache/docs/Cache.html#info)
##### 0.8.x Beta
- AngularCache.keySet()
- AngularCache.keys()
- AngularCache.setOptions()
- Bug fixes
- Submit project to Angular.js user groups for feedback again.

Expand Down

0 comments on commit 9ce0d96

Please sign in to comment.