README.md in libcache-0.3 vs README.md in libcache-0.4
- old
+ new
@@ -1,19 +1,18 @@
# Libcache [](https://travis-ci.org/silk8192/libcache) [](https://badge.fury.io/rb/libcache)
-A simple caching library that provides flexible and powerful caching features such as in-memory and file based caching similar to Guava's Caching system.
+A simple caching library that provides flexible and powerful caching features such as in-memory and file based caching similar to Guava's Caching system. [Docs.](http://www.rubydoc.info/gems/libcache)
## Features
* Supports in-memory cache
* Supports filesystem based cache
* Limiting the size of the cache through eviction based on a specified max size
* Allows for expiration behavior based on the time since an object was placed in the cache or when it was last accessed/updated
* Allows custom refresh functions for reloading expensive data once it has been discarded
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -41,11 +40,11 @@
cache.get(1) # will return 105 as the data has been refreshed
cache.exists?(1) # will return true. if there is no set_refresh method provided then it will return false
# delete all data on exit of program
at_exit do
- cache.invalidateAll
+ cache.invalidate_all
end
```
For an file-based Cache with an expiry time of 3 seconds, store location at 'foo\bar', and refresh method where 100 is added to the key (of course more sophisticated value retrieving operations will replace this method). Of course these additions are optional and configurable. The only thing that is non-removable is the ```set_store``` method.
@@ -59,10 +58,10 @@
cache.exists?(1) # will return true. if there is no set_refresh method provided then it will return false
# delete all leftover files on exit of program
at_exit do
- cache.invalidateAll
+ cache.invalidate_all
end
```
For more on what kind of strings are understood as times, [click here](https://github.com/jmettraux/rufus-scheduler/blob/two/README.rdoc#the-time-strings-understood-by-rufus-scheduler).