chatspry 0.0.1.pre3 → 0.0.1.pre4

data/README.md

@@ -1,29 +1,68 @@
 # Chatspry
 
-TODO: Write a gem description
+API wrapper for Chatspry to be used from any ruby **1.9**, **2.0**
+or **2.1** application. Dependent on the following libraries:
+
+- [Faraday](https://github.com/lostisland/faraday)
+- [Hashie](https://github.com/intridea/hashie)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your project Gemfile:
 
-    gem 'chatspry'
+```ruby
+gem "chatspry", "~> 0.0.1.pre3"
+```
 
-And then execute:
+Then execute this in a command line from your project directory:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or install it on it's own with RubyGems:
 
-    $ gem install chatspry
+```bash
+$ gem install chatspry
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic usage
+
+```ruby
+require "chatspry"
+
+client = Chatspry::Client.new
+client.access_token = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+
+user = client.get("/v1/user")
+# => { "user" => { "id"=>"...", "handle"=>"zeeraw", "name"=>"Philip Vieira", "updated_at"=>1403036249, "created_at"=>1403036249 } }
+
+user.handle
+# => "zeeraw"
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/chatspry/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+#### 1. Fork it at https://github.com/chatspry/chatspry.rb/fork
+
+#### 2. Create your feature branch nested under `feature/`
+
+```bash
+$ git checkout -b feature/my-important-change
+```
+
+#### 3. Commit your changes
+
+```bash
+$ git commit -am 'The gem now behaves this way, because reasons'
+```
+
+#### 4. Push to the branch
+
+```bash
+$ git push origin feature/my-important-change
+```
+
+#### 5. Create a new Pull Request

data/lib/chatspry/client.rb

@@ -25,7 +25,7 @@ module Chatspry
     end
 
     def inspect
-      string = ["<Chatspry::Client:"]
+      string = ["<Chatspry::Client"]
       string << "identifier: #{ @identifier }" if @identifier
       string << "passphrase: #{ "*******" }" if @passphrase
       string << "access_token: #{'*'*56}#{@access_token[56..-1] }" if @access_token

data/lib/chatspry/version.rb

@@ -1,3 +1,3 @@
 module Chatspry
-  VERSION = "0.0.1.pre3"
+  VERSION = "0.0.1.pre4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chatspry
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre3
+  version: 0.0.1.pre4
   prerelease: 6
 platform: ruby
 authors: