steam_api 0.1.4 → 0.1.5

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: f6861608195394cedd845a664820c353550e8f7e
4
- data.tar.gz: 3695404ab0cd6d7fb2cb4c82ea43c621139160ce
3
+ metadata.gz: 4a8c1e06c8da16a0a0411e520f789095ba26679e
4
+ data.tar.gz: 9c2d5984b17cda8e39ae5c61f901409f7c2700a8
5
5
  SHA512:
6
- metadata.gz: c7713367fd60b6065ca60be959a61236adcaa289620c6941d872dd54d132cd7f788da4d37c67060a6f7ea57925e3b6c9888e91d7ed1b9a2e90f920913626c2c1
7
- data.tar.gz: 2684ebccfa67cd2ead35934c9c01d0977d777c7349b2ec216c5f99c6f7e820ae097db168ad0b0e2efea9ccc6f1bb1b1875cc67fcd0a0e52e8bca4da8ab0a617a
6
+ metadata.gz: 766a9665fbd3fa3d097c2db0973713654e92b69b4b94c1cfa0255097f060a55fc1deff09393f69366811b5182431dafe12bff5523bb218cb493e2291821b624a
7
+ data.tar.gz: b4c4e8e32890c14dd557355a52baf5e1b4902002ca05fb8c59d3a16c2309ffba191924f182bcd750b483c9b5e42379079458952c271720206a8f0e7c26e57746
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # SteamApi
2
2
 
3
- TODO: Write a gem description
3
+ SteamApi is a Ruby gem which allows you to interact with certain parts of the Steam Web API. It is a work in progress, as all methods are not completely implemented yet. Feel free to contribute :)
4
4
 
5
5
  ## Installation
6
6
 
@@ -20,7 +20,29 @@ Or install it yourself as:
20
20
 
21
21
  ## Usage
22
22
 
23
- TODO: Write usage instructions here
23
+ All the methods to interact with the gem can be called after initializing a Client object.
24
+
25
+ Example:
26
+
27
+ ```ruby
28
+ client = SteamApi::Client.new("###INSERT STEAM API KEY HERE###")
29
+ ```
30
+
31
+ This will allow you to call methods such as:
32
+
33
+ ```ruby
34
+ client.get_friend_list('2834798123')
35
+ ```
36
+ where the number that is passed in the user's SteamID64. In order to fetch a user's SteamID64, you can call:
37
+
38
+ ```ruby
39
+ client.resolve_vanity_url('youda')
40
+ ```
41
+ where the string that is passed in is the Steam username. The SteamID64 is very important if you are wishing to gather information about certain users, many of the methods implement it.
42
+
43
+ For more information about other available methods, please refer to the documentation at http://www.rubydoc.info/github/YusefOuda/steam-api/master/frames
44
+
45
+ Information about the Steam API can be found at https://wiki.teamfortress.com/wiki/WebAPI and https://developer.valvesoftware.com/wiki/Steam_Web_API
24
46
 
25
47
  ## Contributing
26
48
 
@@ -1,4 +1,4 @@
1
1
  module SteamApi
2
2
  # The current version
3
- VERSION = "0.1.4"
3
+ VERSION = "0.1.5"
4
4
  end
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: steam_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.4
4
+ version: 0.1.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Yusef Ouda
@@ -185,6 +185,7 @@ files:
185
185
  - steam_api-0.1.1.gem
186
186
  - steam_api-0.1.2.gem
187
187
  - steam_api-0.1.3.gem
188
+ - steam_api-0.1.4.gem
188
189
  - steam_api.gemspec
189
190
  homepage: http://github.com/YusefOuda/steam-api
190
191
  licenses: