README.md in legion-cache-1.1.1 vs README.md in legion-cache-1.2.0

- old
+ new

@@ -1,31 +1,59 @@ -# Legion::Cache +Legion::Cache +===== -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/legion/cache`. To experiment with that code, run `bin/console` for an interactive prompt. +Legion::Cache is a wrapper class to handle requests to the caching tier. It supports both memcached and redis -## Installation +Supported Ruby versions and implementations +------------------------------------------------ -Add this line to your application's Gemfile: +Legion::Json should work identically on: -```ruby -gem 'legion-cache' -``` +* JRuby 9.2+ +* Ruby 2.4+ -And then execute: - $ bundle install +Installation and Usage +------------------------ -Or install it yourself as: +You can verify your installation using this piece of code: - $ gem install legion-cache +```bash +gem install legion-cache +``` -## Usage +```ruby +require 'legion/cache' +Legion::Cache.setup +Legion::Cache.connected? # => true +Legion::Cache.set('foobar', 'testing', ttl: 10) +Legion::Cache.get('foobar') # => 'testing' +sleep(11) +Legion::Cache.get('foobar') # => nil -## Contributing +``` -Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/legion-io/legion-cache/issues +Settings +---------- +```json +{ + "driver": "dalli", + "servers": [ + "127.0.0.1:11211" + ], + "connected": false, + "enabled": true, + "namespace": "legion", + "compress": false, + "cache_nils": false, + "pool_size": 10, + "timeout": 10, + "expires_in": 0 +} +``` -## License +Authors +---------- -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +* [Matthew Iverson](https://github.com/Esity) - current maintainer