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 +4 -4
- data/README.md +27 -1
- data/lib/speakerdeck_api/version.rb +1 -1
- data/lib/speakerdeck_api.rb +0 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 55f50730158b9885ae5dfc446fa858fb9c4aa031
|
4
|
+
data.tar.gz: 67801b1df47b56b551e288f1c580ac66aa083ab0
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
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
|
-
|
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
|
|
data/lib/speakerdeck_api.rb
CHANGED