README.md in pixy-0.1.0 vs README.md in pixy-0.1.1
- old
+ new
@@ -1,22 +1,24 @@
-# Pixy
+# Pixy [![Build Status](https://secure.travis-ci.org/NARKOZ/pixy.png)](http://travis-ci.org/NARKOZ/pixy)
-[![Build Status](https://secure.travis-ci.org/NARKOZ/pixy.png)](http://travis-ci.org/NARKOZ/pixy)
-
Pixy is an API wrapper for Pixiv url shortener - [p.tl](http://p.tl/)
## Installation
-```ruby
-gem 'pixy'
-# gem install pixy
+```sh
+gem install pixy
```
## Usage
+Get an API key here: http://p.tl/key_create.php
+
```ruby
Pixy.shorten!(API_KEY, 'https://github.com/narkoz/pixy')
# => "http://p.tl/Us9R"
+
+Pixy.stats API_KEY
+# => {:calls=>12, :limit=>988}
pixy = Pixy.shorten(API_KEY, 'https://github.com/narkoz/pixy')
# => #<Pixy::Shorten:0x0000010201bde8 @status="ok", @long_url="https://github.com/narkoz/pixy", @short_url="http://p.tl/Us9R", @counter=20>
pixy.status