Skip to content
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.

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

Update the README.md #6

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from 3 commits
Commits
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
44 changes: 28 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
## RetroAchievements composer package
# RetroAchievements composer package
```sh
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you remove the bash markup around the description?

RetroAchievements composer Package is a simple wrapper around the RetroAchievements.org API written in PHP
```

# Open Source

Install with:
RetroAchievements composer package is completely open sourced.

`composer require joestrong/retroachievements`

Use in a project:

# Installation
```sh
$ composer require joestrong/retroachievements
```

# Getting Started Usage

```sh
require_once('../vendor/autoload.php');

use JoeStrong\RetroAchievements\RetroAchievements;
Expand All @@ -19,20 +29,22 @@ foreach ($users as $user) {
}
```

## Methods

Auth with the API
### Methods

`$ra = new RetroAchievements($username, $apiKey);`

Get the top 10 users

`$ra->getTopTenUsers();`
```php
// Auth with the API
$ra = new RetroAchievements($username, $apiKey);

Get the consoles
// Get the top 10 users
$ra->getTopTenUsers();

`$ra->getConsoles();`
// Get the consoles
$ra->getConsoles();

Get games for console
// Get games for console
$ra->getGamesForConsole($consoleId);
```
License
----

`$ra->getGamesForConsole($consoleId);`
MIT