Skip to content

Update README.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ajmeese7 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
PHP Wrapper to communicate with Steam Web API

# SteamID64 Finder
Please refer to [http://steamid.co/](http://steamid.co/) or [http://steamidconverter.com/](http://steamidconverter.com/) to find the user steam id.
Please refer to [http://steamid.co/](http://steamid.co/) or [http://steamidconverter.com/](http://steamidconverter.com/) to find the user's Steam ID.


# Install
Expand Down Expand Up @@ -101,7 +101,7 @@ $player->IsPlayingSharedGame($gameId);
$news = new \SteamApi\News('YOUR-STEAM-KEY');
```

#### Get News For App
#### Get News for App

```
$news->GetNewsForApp($appId[, $numberOfNews, $maxLength]); // Last 2 arguments are optional
Expand All @@ -119,7 +119,7 @@ $app = new \SteamApi\App('YOUR-STEAM-KEY');
$app->appDetails($appId);
```

#### Get Servers At Address
#### Get Servers at Address
```
$app->GetServersAtAddress($address); // Hostname or IP:Port
```
Expand All @@ -140,19 +140,19 @@ $app->UpToDateCheck($appId, $appVersion);
$stats = new Stats('YOUR-STEAM-KEY', 'THE-STEAMID64');
```

#### Get Global Stats For Game
#### Get Global Stats for Game
```
$stats->GetGlobalStatsForGame($gameId, array('STATS-NAME'));
// Example
$stats->GetGlobalStatsForGame(17740, array('global.map.emp_isle'));
```

#### Get Number Of Current Players
#### Get Number of Current Players
```
$stats->GetNumberOfCurrentPlayers($appId);
```

#### Get Schema For Game
#### Get Schema for Game
```
$stats->GetSchemaForGame($appId);
```
Expand All @@ -162,21 +162,21 @@ $stats->GetSchemaForGame($appId);
$stats->GetPlayerAchievements($appId);
```

#### Get Global Achievement Percentages For App
#### Get Global Achievement Percentages for App
```
$stats->GetGlobalAchievementPercentagesForApp($appId);
```

#### Get User Stats Fo rGame
#### Get User Stats for Game
```
$stats->GetUserStatsForGame($appId);
```

# More Info
Please Refer to the tests folder to get more information on how to use the library
Please refer to the tests folder to get more information on how to use the library.

# Objective
The objective of this library is to wrap the steam web API into a php object.
The objective of this library is to wrap the Steam Web API into a PHP object.

There are some missing methods that I plan to implement soon.

Expand All @@ -191,11 +191,11 @@ The missing methods can be found using the [swissapiknife](https://github.com/La
You do need PHP 5.4+ and composer. You also need to load the `vendor/autoload.php` into your project.

## Will this work on my framework?
This library is framework agnostic, maybe the framework you're using requires some aditional setup.
This library is framework agnostic, but the framework you're using may require additional setup.

If your framework uses composer you should be good to go. But let me know if you run into any troubles.
If your framework uses Composer you should be good to go, but let me know if you run into any troubles.

## Found a bug, what should I do?
If you have the capacity to fix it yourself by all means do and create a pull request.
If you have the capacity to fix it yourself, by all means do and create a pull request.

If you don't, raise an issue on github and me or someone else will try to fix it.
If you don't, raise an issue on GitHub and me or someone else will try to fix it.