speakerdeck_api 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 3892efbff2761e7e134553b668c35f548cabf3d9
4
- data.tar.gz: 9acae837f0c8370cd9c5d2819889d452b0dda84a
3
+ metadata.gz: 55f50730158b9885ae5dfc446fa858fb9c4aa031
4
+ data.tar.gz: 67801b1df47b56b551e288f1c580ac66aa083ab0
5
5
  SHA512:
6
- metadata.gz: 9268702f1ac2caccaf604ab945d3a0492e8bbf338167dbb5a6807e21a82814af55c3643d91db46152c57b102840db226a3010310b60cd6d957b65d7064dcfc5d
7
- data.tar.gz: 22f442d296feace4492a03bf841d661655c4c6719936728137dfc20cf0d6b90d7b8113376949cecd974113b4e0171955bdd13b72ed3709c7e54efe7d0baee3cd
6
+ metadata.gz: 9df5f38624f207adbbf3788621de904e8ca0881d3b9cea13ac07f3edda5a485ab7cb1c5f1f70ec7fb92195d03c765de7d44ee3cc2fd98a223f82339b83adbc16
7
+ data.tar.gz: ebccac828a713621aeb4ac911fb946c7a7ee7cf1d43f1e251abbb505361a4b755aa5353e534cdc8e82c3dfc04ebbd92738d1c8d133aae53f364d7241143b22a8
data/README.md CHANGED
@@ -22,7 +22,33 @@ Or install it yourself as:
22
22
 
23
23
  ## Usage
24
24
 
25
- TODO: Write usage instructions here
25
+ First require the gem:
26
+
27
+ ```ruby
28
+ require 'speakerdeck_api'
29
+ ```
30
+
31
+ At the moment, you can get the number of talks by a speaker via the
32
+ SpeakerdeckApi::Speaker class.
33
+
34
+ ```ruby
35
+ speaker = SpeakerdeckApi::Speaker.get 'speakerdeck.com user'
36
+ ```
37
+
38
+ This return an object with the number_of_talks attribute:
39
+
40
+ ```ruby
41
+ speaker.number_of_talks
42
+ => 8
43
+ ```
44
+
45
+ You will get a SpeakerNotFound exception in case the provided speaker
46
+ name does not correspond to a speackerdeck.com user.
47
+
48
+ ## Upcoming
49
+
50
+ * Retrive more information about the speaker
51
+ * Add SpeakerdeckApi::Talk class to retrieve talk details
26
52
 
27
53
  ## Contributing
28
54
 
@@ -1,3 +1,3 @@
1
1
  module SpeakerdeckApi
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
@@ -5,5 +5,4 @@ require 'speakerdeck_api/speaker'
5
5
  require 'speakerdeck_api/exceptions/speaker_not_found_exception'
6
6
 
7
7
  module SpeakerdeckApi
8
- # Your code goes here...
9
8
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: speakerdeck_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Fer Perales