Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
- Updated `appDetails`
- Added `packageDetails`
  • Loading branch information
Ernest E committed Jul 19, 2018
1 parent 5198977 commit 907d68a
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ Each service from the steam api has it's own methods you can use.
- [User](#user)
- [User Stats](#user-stats)
- [App](#app)
- [Package](#package)
- [Group](#group)

### Global
Expand Down Expand Up @@ -304,13 +305,15 @@ Steam::app()
```

#### appDetails
This gets all the details for a game. This is most of the infomation from the store page of a game.
This gets all the details for a game. This is most of the information from the store page of a game.

##### Arguments

Name | Type | Description | Required | Default
-----|------|-------------|----------|---------
appIds| int[] | The ids of the games you want details for | Yes |
cc | string | The cc is the country code, you can get appropriate currency values according to [ISO 3166-1](https://wikipedia.org/wiki/ISO_3166-1) | No |
l | string | The l is the language parameter, you can get the appropriate language according to [ISO 639-1](https://wikipedia.org/wiki/ISO_639-1) (If there is one) | No |


> Example Output: [appDetails](./examples/app/appDetails.txt)
Expand All @@ -320,6 +323,27 @@ This method will return an array of app objects directly from steam. It include

> Example Output: [GetAppList](./examples/app/GetAppList.txt)
### Package
This method will get details for packages.

```php
Steam::package()
```

#### packageDetails
This gets all the details for a package. This is most of the information from the store page of a package.

##### Arguments

Name | Type | Description | Required | Default
-----|------|-------------|----------|---------
packIds| int[] | The ids of the packages you want details for | Yes |
cc | string | The cc is the country code, you can get appropriate currency values according to [ISO 3166-1](https://wikipedia.org/wiki/ISO_3166-1) | No |
l | string | The l is the language parameter, you can get the appropriate language according to [ISO 639-1](https://wikipedia.org/wiki/ISO_639-1) (If there is one) | No |


> Example Output: [packageDetails](./examples/package/packageDetails.txt)
### Group
This service is used to get details on a steam group.

Expand Down

0 comments on commit 907d68a

Please sign in to comment.