Skip to content

Commit ca28fcc

Browse files
Merge pull request #68 from ajmeese7/master
Update README.md
2 parents 676aa83 + e0faf84 commit ca28fcc

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- [Usage](#usage)
1515
- [Contributors](#contributors)
1616

17-
This package provides an easy way to get details from the steam api service. The services it can access are:
17+
This package provides an easy way to get details from the Steam API service. The services it can access are:
1818

1919
- `ISteamNews`
2020
- `IPlayerService`
@@ -42,13 +42,13 @@ Once that is finished, add the service provider to `config/app.php`
4242

4343
> The alias to Steam is already handled by the package.
4444
45-
Lastly, publish the config file. You can get your API key from [Steam](http://steamcommunity.com/dev/apikey)
45+
Lastly, publish the config file. You can get your API key from [Steam](http://steamcommunity.com/dev/apikey).
4646

4747
php artisan vendor:publish
4848

4949
## Usage
5050

51-
Each service from the steam api has it's own methods you can use.
51+
Each service from the Steam API has its own methods you can use.
5252

5353
- [Global](#global)
5454
- [News](#news)
@@ -59,7 +59,7 @@ Each service from the steam api has it's own methods you can use.
5959
- [Group](#group)
6060

6161
### Global
62-
These are methods that are available to each service
62+
These are methods that are available to each service.
6363

6464
#### convertId
6565
This will convert the given steam ID to each type of steam ID (64 bit, 32 bit and steam ID3).
@@ -89,7 +89,7 @@ Steam::news()
8989
```
9090

9191
#### GetNewsForApp
92-
This method will get the news articles for a given app id. It has three parameters.
92+
This method will get the news articles for a given app ID. It has three parameters.
9393

9494
##### Arguments
9595

@@ -112,14 +112,14 @@ maxlength | int | The maximum number of characters to return | No | null
112112
### Player
113113
The [Player Service](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetOwnedGames_.28v0001.29) is used to get details on players.
114114

115-
When instantiating the player class, you are required to pass a steamId or steam community ID.
115+
When instantiating the player class, you are required to pass a steamId or Steam community ID.
116116

117117
```php
118118
Steam::player($steamId)
119119
```
120120

121121
#### GetSteamLevel
122-
This method will return the level of the steam user given. It simply returns the integer of their current level.
122+
This method will return the level of the Steam user given. It simply returns the integer of their current level.
123123

124124

125125
> Example Output: [GetSteamLevel](./examples/player/GetSteamLevel.txt)
@@ -131,13 +131,13 @@ This will return a Syntax\Containers\Player_Level object with full details for t
131131
> Example Output: [GetPlayerLevelDetails](./examples/player/GetPlayerLevelDetails.txt)
132132
133133
#### GetBadges
134-
This call will give you a list of the badges that the player currently has. There is currently no schema for badges so all you will get is the id and details.
134+
This call will give you a list of the badges that the player currently has. There is currently no schema for badges, so all you will get is the ID and details.
135135

136136

137137
> Example Output: [GetBadges](./examples/player/GetBadges.txt)
138138
139139
#### GetOwnedGames
140-
GetOwnedGames returns a list of games a player owns along with some playtime information, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (ie the WebAPI key you are using is linked to the steamid you are requesting).
140+
GetOwnedGames returns a list of games a player owns along with some playtime information, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (i.e. the WebAPI key you are using is linked to the steamID you are requesting).
141141

142142
##### Arguments
143143

@@ -151,7 +151,7 @@ appIdsFilter | array | An array of appIds. These will be the only ones returned
151151
> Example Output: [GetOwnedGames](./examples/player/GetOwnedGames.txt)
152152
153153
#### GetRecentlyPlayedGames
154-
GetRecentlyPlayedGames returns a list of games a player has played in the last two weeks, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (ie the WebAPI key you are using is linked to the steamid you are requesting).
154+
GetRecentlyPlayedGames returns a list of games a player has played in the last two weeks, if the profile is publicly visible. Private, friends-only, and other privacy settings are not supported unless you are asking for your own personal details (i.e. the WebAPI key you are using is linked to the steamID you are requesting).
155155

156156
##### Arguments
157157

@@ -176,7 +176,7 @@ appId| int | The game to check for | Yes |
176176
### User
177177
The [User](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetFriendList_.28v0001.29) WebAPI call is used to get details about the user specifically.
178178

179-
When instantiating the user class, you are required to pass a steamId or steam community ID.
179+
When instantiating the user class, you are required to pass a steamID or Steam community ID.
180180

181181
```php
182182
Steam::user($steamId)
@@ -204,7 +204,7 @@ This will return details on the user.
204204

205205
Name | Type | Description | Required | Default
206206
-----|------|-------------|----------|---------
207-
steamId| int[] | An array of (or singular) steam id(s) to get details for | No | Steam id passed to user()
207+
steamId| int[] | An array of (or singular) steam ID(s) to get details for | No | Steam ID passed to user()
208208

209209
```php
210210
$player = Steam::user($steamId)->GetPlayerSummaries()[0];
@@ -241,14 +241,14 @@ steamId| int[] | An array of (or singular) steam id(s) to get details for | No
241241
### User Stats
242242
The [User Stats](https://developer.valvesoftware.com/wiki/Steam_Web_API#GetPlayerAchievements_.28v0001.29) WebAPI call is used to get details about a user's gaming.
243243

244-
When instantiating the user stats class, you are required to pass a steamId or steam community ID.
244+
When instantiating the user stats class, you are required to pass a steamID or Steam community ID.
245245

246246
```php
247247
Steam::userStats($steamId)
248248
```
249249

250250
#### GetPlayerAchievements
251-
Returns a list of achievements for this user by app id.
251+
Returns a list of achievements for this user by app ID.
252252

253253
##### Arguments
254254

@@ -260,38 +260,38 @@ appId| int | The id of the game you want the user's achievements in | Yes |
260260
> Example Output: [GetPlayerAchievements](./examples/user/stats/GetPlayerAchievements.txt)
261261
262262
#### GetGlobalAchievementPercentagesForApp
263-
This method will return a list of all chievements for the specified game and the percentage that each achievement has been unlocked.
263+
This method will return a list of all achievements for the specified game and the percentage of all users that have unlocked each achievement.
264264

265265
##### Arguments
266266

267267
Name | Type | Description | Required | Default
268268
-----|------|-------------|----------|---------
269-
appId| int | The id of the game you want the user's achievements in | Yes |
269+
appId| int | The ID of the game you want the user's achievements in | Yes |
270270

271271

272272
> Example Output: [GetGlobalAchievementPercentagesForApp](./examples/user/stats/GetGlobalAchievementPercentageForApp.txt)
273273
274274
#### GetUserStatsForGame
275-
Returns a list of achievements for this user by app id.
275+
Returns a list of achievements for this user by app ID.
276276

277277
##### Arguments
278278

279279
Name | Type | Description | Required | Default
280280
-----|------|-------------|----------|---------
281-
appId| int | The id of the game you want the user's achievements in | Yes |
281+
appId| int | The ID of the game you want the user's achievements in | Yes |
282282
all| boolean | If you want all stats and not just the achievements set to true.| No | FALSE
283283

284284

285285
> Example Output: [GetUserStatsForGame](./examples/user/stats/GetUserStatsForGame.txt) | [GetUserStatsForGame (all)](./examples/user/stats/GetUserStatsForGameAll.txt)
286286
287287
#### GetSchemaForGame
288-
Returns a list of game details including achievements and stats.
288+
Returns a list of game details, including achievements and stats.
289289

290290
##### Arguments
291291

292292
Name | Type | Description | Required | Default
293293
-----|------|-------------|----------|---------
294-
appId| int | The id of the game you want the details for. | Yes |
294+
appId| int | The ID of the game you want the details for. | Yes |
295295

296296

297297
> Example Output: [GetSchemaForGame](./examples/user/stats/GetSchemaForGame.txt)
@@ -316,12 +316,12 @@ appIds| int[] | The ids of the games you want details for | Yes |
316316
> Example Output: [appDetails](./examples/app/appDetails.txt)
317317
318318
#### GetAppList
319-
This method will return an array of app objects directly from steam. It includes the appId and the app name.
319+
This method will return an array of app objects directly from Steam. It includes the appID and the app name.
320320

321321
> Example Output: [GetAppList](./examples/app/GetAppList.txt)
322322
323323
### Group
324-
This service is used to get details on a steam group.
324+
This service is used to get details on a Steam group.
325325

326326
```php
327327
Steam::group()
@@ -334,7 +334,7 @@ This method will get the details for a group.
334334

335335
Name | Type | Description | Required | Default
336336
-----|------|-------------|----------|---------
337-
group| string or int | The id or the name of the group. | Yes
337+
group| string or int | The ID or the name of the group. | Yes
338338

339339
##### Example usage
340340

0 commit comments

Comments
 (0)