speakerdeck_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3892efbff2761e7e134553b668c35f548cabf3d9
-  data.tar.gz: 9acae837f0c8370cd9c5d2819889d452b0dda84a
+  metadata.gz: 55f50730158b9885ae5dfc446fa858fb9c4aa031
+  data.tar.gz: 67801b1df47b56b551e288f1c580ac66aa083ab0
 SHA512:
-  metadata.gz: 9268702f1ac2caccaf604ab945d3a0492e8bbf338167dbb5a6807e21a82814af55c3643d91db46152c57b102840db226a3010310b60cd6d957b65d7064dcfc5d
-  data.tar.gz: 22f442d296feace4492a03bf841d661655c4c6719936728137dfc20cf0d6b90d7b8113376949cecd974113b4e0171955bdd13b72ed3709c7e54efe7d0baee3cd
+  metadata.gz: 9df5f38624f207adbbf3788621de904e8ca0881d3b9cea13ac07f3edda5a485ab7cb1c5f1f70ec7fb92195d03c765de7d44ee3cc2fd98a223f82339b83adbc16
+  data.tar.gz: ebccac828a713621aeb4ac911fb946c7a7ee7cf1d43f1e251abbb505361a4b755aa5353e534cdc8e82c3dfc04ebbd92738d1c8d133aae53f364d7241143b22a8

data/README.md

@@ -22,7 +22,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First require the gem:
+
+```ruby
+require 'speakerdeck_api'
+```
+
+At the moment, you can get the number of talks by a speaker via the
+SpeakerdeckApi::Speaker class.
+
+```ruby
+speaker = SpeakerdeckApi::Speaker.get 'speakerdeck.com user'
+```
+
+This return an object with the number_of_talks attribute:
+
+```ruby
+speaker.number_of_talks
+=> 8
+```
+
+You will get a SpeakerNotFound exception in case the provided speaker
+name does not correspond to a speackerdeck.com user.
+
+## Upcoming
+
+* Retrive more information about the speaker
+* Add SpeakerdeckApi::Talk class to retrieve talk details
 
 ## Contributing
 

data/lib/speakerdeck_api/version.rb

@@ -1,3 +1,3 @@
 module SpeakerdeckApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/speakerdeck_api.rb

@@ -5,5 +5,4 @@ require 'speakerdeck_api/speaker'
 require 'speakerdeck_api/exceptions/speaker_not_found_exception'
 
 module SpeakerdeckApi
-  # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: speakerdeck_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Fer Perales