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.

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

Update the README.md #6

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update the README.md #6

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9182c06
Update the README.md
waleCloud Oct 12, 2017
a05e8c3
Updated REAME.md
waleCloud Oct 12, 2017
2d78c9e
Additional Changes made
waleCloud Oct 13, 2017
670da19
Readme.md file updated
Oct 14, 2017
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
31 changes: 22 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
## 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
Copy link
Owner

Choose a reason for hiding this comment

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

This should be just a regular sentence (no bash syntax/comment)

*/
```

# Open Source

Install with:
- RetroAchievements composer package is completely open sourced.
Copy link
Owner

Choose a reason for hiding this comment

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

Remove the bullet point


`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 +30,22 @@ foreach ($users as $user) {
}
```

## Methods
### Methods

```php
Auth with the API
Copy link
Owner

Choose a reason for hiding this comment

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

Make the descriptions in the PHP block comments


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

Get the top 10 users

`$ra->getTopTenUsers();`
$ra->getTopTenUsers();

Get the consoles

`$ra->getConsoles();`
$ra->getConsoles();

Get games for console

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