README.md in url_tokenizer-0.2.0 vs README.md in url_tokenizer-1.0.0
- old
+ new
@@ -1,11 +1,11 @@
UrlTokenizer
================================
[![Build Status](https://travis-ci.org/AlexParamonov/url_tokenizer.png?branch=master)](https://travis-ci.org/AlexParamonov/url_tokenizer)
[![Gemnasium Build Status](https://gemnasium.com/AlexParamonov/url_tokenizer.png)](http://gemnasium.com/AlexParamonov/url_tokenizer)
-[![Coverage Status](https://coveralls.io/repos/AlexParamonov/url_tokenizer/badge.png?branch=master)](https://coveralls.io/r/AlexParamonov/url_tokenizer?branch=master)
[![Gem Version](https://badge.fury.io/rb/url_tokenizer.png)](http://badge.fury.io/rb/url_tokenizer)
+[![Test Coverage](https://codeclimate.com/github/AlexParamonov/url_tokenizer/badges/coverage.svg)](https://codeclimate.com/github/AlexParamonov/url_tokenizer/coverage)
[![Code Climate](https://codeclimate.com/github/AlexParamonov/url_tokenizer.png)](https://codeclimate.com/github/AlexParamonov/url_tokenizer)
Tokenize url by variety of providers
Contents
@@ -30,33 +30,31 @@
Or install it yourself as:
$ gem install url_tokenizer
-You'll need UrlTokenizer provider gems as well:
+UrlTokenizer gem has Limelight and CDN77 providers bundled.
- $ gem install url_tokenizer-provider-limelight
-
Requirements
------------
-1. Ruby >= 1.9
-1. UrlTokenizer gem
+1. Ruby >= 2.1
Usage
------------
Register provider using `UrlTokenizer.register`
``` ruby
-UrlTokenizer.register 'LL' => UrlTokenizer::Provider::Limelight
+require 'url_tokenizer/limelight'
+UrlTokenizer.register 'LL' => UrlTokenizer::Limelight.new('super_secret_key')
```
Obtain provider and tokenize url:
``` ruby
-tokenizer = UrlTokenizer.provider('LL', key: 'super_secret_key')
-tokenizer.call url, expire_in: 1.hour
+tokenizer = UrlTokenizer.provider 'LL'
+tokenizer.call url, expires_in: 1.hour
```
Contacts
-------------
Have questions or recommendations? Contact me via `alexander.n.paramonov@gmail.com`
@@ -68,14 +66,11 @@
-------------
tested with Ruby:
* 2.2
* 2.1
-* 2.0
-* 1.9.3
* ruby-head
* rbx-2
-* jruby-19mode
* jruby-head
See [build history](http://travis-ci.org/#!/AlexParamonov/url_tokenizer/builds)