Merge pull request #24 from LogansUA/feature-update-project

General updates

Author: LogansUA

.github/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+First of all, **thank you** for contributing, **you are awesome**!
+
+Here are a few rules to follow in order to ease code reviews, and discussions before
+maintainers accept and merge your work.
+
+As library follows the next standards: [PSR-0](http://www.php-fig.org/psr/psr-0/), [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/), [PSR-4](http://www.php-fig.org/psr/psr-4/). You also MUST follow them.
+
+You SHOULD follow the [Symfony Coding Standards](http://symfony.com/doc/current/contributing/code/standards.html).
+If you don't know about any of them, you should really read the recommendations.  
+You can use a helpful tool [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) with a last version of [Symfony standards](https://github.com/escapestudios/Symfony2-coding-standard).
+Or you can use a [PHP-CS-Fixer](http://cs.sensiolabs.org/) tool to fix all coding style issues.
+
+You SHOULD write documentation.
+
+Please, write [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), and [rebase your branch](http://git-scm.com/book/en/Git-Branching-Rebasing) before submitting your Pull Request.
+
+One may ask you to [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) too. This is used to "clean" your Pull Request before merging it (we don't want commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
+
+Thank you!

README.md

@@ -10,16 +10,11 @@ API client for Blizzard API written in PHP. [Blizzard API Documentation](https:/
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/b103523d-7f46-4c74-94f9-cf41462b298a/mini.png)](https://insight.sensiolabs.com/projects/b103523d-7f46-4c74-94f9-cf41462b298a)
 
 ## Installation
-### Method 1
 ```
-composer require logansua/blizzard-api-client
+$ composer require logansua/blizzard-api-client
 ```
 This command requires you to have Composer installed globally, as explained
 in the [Composer documentation](https://getcomposer.org/doc/00-intro.md).
-### Method 2
-```
-git clone https://github.com/LogansUA/blizzard-api-php-client.git
-```
 
 ## Basic usage
 ```PHP
@@ -40,11 +35,15 @@ echo $response->getBody();
 ```
 
 ## List of available API services
-* World of Warcraft ([example](https://github.com/LogansUA/blizzard-api-php-client/blob/master/examples/WorldOfWarcraftExample.php))
-* Diablo 3 ([example](https://github.com/LogansUA/blizzard-api-php-client/blob/master/examples/DiabloExample.php))
-* Starcraft ([example](https://github.com/LogansUA/blizzard-api-php-client/blob/master/examples/StarcraftExample.php))
-* Community OAuth ([example](https://github.com/LogansUA/blizzard-api-php-client/blob/master/examples/CommunityOAuthExample.php))
-* Game Data ([example](https://github.com/LogansUA/blizzard-api-php-client/blob/master/examples/GameDataExample.php))
+* World of Warcraft ([example](docs/examples/WorldOfWarcraftExample.php))
+* Diablo 3 ([example](docs/examples/DiabloExample.php))
+* Starcraft ([example](docs/examples/StarcraftExample.php))
+* Community OAuth ([example](docs/examples/CommunityOAuthExample.php))
+* Game Data ([example](docs/examples/GameDataExample.php))
+
+## Contributing
+
+See [CONTRIBUTING](.github/CONTRIBUTING.md) file.
 
 ## License
-This software is published under the [MIT License](https://github.com/LogansUA/blizzard-api-php-client/blob/master/LICENSE)
+This software is published under the [MIT License](LICENSE)

composer.json

@@ -2,23 +2,34 @@
     "name": "logansua/blizzard-api-php-client",
     "description": "API client for blizzard API written in PHP",
     "keywords": ["blizzard", "world of warcraft", "api", "client"],
-    "minimum-stability": "dev",
+    "homepage": "https://github.com/LogansUA/blizzard-api-php-client",
     "type": "library",
     "license": "MIT",
     "authors": [
         {
             "name": "Oleg Kachinskiy",
-            "email": "Logansoleg@gmail.com"
+            "email": "logansoleg@gmail.com",
+            "role": "Creator"
+        },
+        {
+            "name": "Community",
+            "homepage": "https://github.com/LogansUA/blizzard-api-php-client/graphs/contributors",
+            "role": "Contributors"
         }
     ],
+    "support": {
+        "email": "logansoleg@gmail.com",
+        "issues": "https://github.com/LogansUA/blizzard-api-php-client/issues"
+    },
     "require": {
         "php": ">=5.6.0",
-        "guzzlehttp/guzzle": "^6.1@dev",
+        "guzzlehttp/guzzle": "^6.2",
         "symfony/options-resolver": "^3.0"
     },
     "autoload": {
         "psr-4": {
             "BlizzardApi\\": "src/"
         }
-    }
+    },
+    "minimum-stability": "stable"
 }

composer.lock

@@ -1,7 +1,7 @@
 <?php
 
 // Include composer autoload file
-require_once __DIR__.'/../vendor/autoload.php';
+require_once __DIR__.'/../../vendor/autoload.php';
 
 // Create a new Blizzard client with Blizzard API key and secret
 $client = new \BlizzardApi\BlizzardClient('apiKey', 'apiSecret');
@@ -12,8 +12,11 @@
 // Use API method for getting specific data
 $response = $diablo->getProfileUser();
 
-// $response->getStatusCode(); - accessing response status code
-// $response->getHeaders(); - accessing response headers
+// Accessing response status code
+$response->getStatusCode();
+
+// Accessing response headers
+$response->getHeaders();
 
 // Show response body
 echo $response->getBody();

examples/CommunityOAuthExample.php renamed to docs/examples/CommunityOAuthExample.php

@@ -1,7 +1,7 @@
 <?php
 
 // Include composer autoload file
-require_once __DIR__.'/../vendor/autoload.php';
+require_once __DIR__.'/../../vendor/autoload.php';
 
 // Create a new Blizzard client with Blizzard API key and secret
 $client = new \BlizzardApi\BlizzardClient('apiKey', 'apiSecret');
@@ -12,8 +12,11 @@
 // Use API method for getting specific data
 $response = $diablo->getItemDataById('Unique_Shoulder_103_x1');
 
-// $response->getStatusCode(); - accessing response status code
-// $response->getHeaders(); - accessing response headers
+// Accessing response status code
+$response->getStatusCode();
+
+// Accessing response headers
+$response->getHeaders();
 
 // Show response body
 echo $response->getBody();

examples/DiabloExample.php renamed to docs/examples/DiabloExample.php

@@ -1,7 +1,7 @@
 <?php
 
 // Include composer autoload file
-require_once __DIR__.'/../vendor/autoload.php';
+require_once __DIR__.'/../../vendor/autoload.php';
 
 // Create a new Blizzard client with Blizzard API key and secret
 $client = new \BlizzardApi\BlizzardClient('apiKey', 'apiSecret');
@@ -12,8 +12,11 @@
 // Use API method for getting specific data
 $response = $gameData->getEraLeaderboard(1, 'rift-barbarian');
 
-// $response->getStatusCode(); - accessing response status code
-// $response->getHeaders(); - accessing response headers
+// Accessing response status code
+$response->getStatusCode();
+
+// Accessing response headers
+$response->getHeaders();
 
 // Show response body
 echo $response->getBody();

examples/GameDataExample.php renamed to docs/examples/GameDataExample.php

@@ -1,7 +1,7 @@
 <?php
 
 // Include composer autoload file
-require_once __DIR__.'/../vendor/autoload.php';
+require_once __DIR__.'/../../vendor/autoload.php';
 
 // Create a new Blizzard client with Blizzard API key and secret
 $client = new \BlizzardApi\BlizzardClient('apiKey', 'apiSecret');
@@ -12,8 +12,11 @@
 // Use API method for getting specific data
 $response = $starcraft->getAchievements();
 
-// $response->getStatusCode(); - accessing response status code
-// $response->getHeaders(); - accessing response headers
+// Accessing response status code
+$response->getStatusCode();
+
+// Accessing response headers
+$response->getHeaders();
 
 // Show response body
 echo $response->getBody();

examples/StarcraftExample.php renamed to docs/examples/StarcraftExample.php

@@ -1,7 +1,7 @@
 <?php
 
 // Include composer autoload file
-require_once __DIR__.'/../vendor/autoload.php';
+require_once __DIR__.'/../../vendor/autoload.php';
 
 // Create a new Blizzard client with Blizzard API key and secret
 $client = new \BlizzardApi\BlizzardClient('apiKey', 'apiSecret');
@@ -14,8 +14,11 @@
     'fields' => 'achievements,challenge',
 ]);
 
-// $response->getStatusCode(); - accessing response status code
-// $response->getHeaders(); - accessing response headers
+// Accessing response status code
+$response->getStatusCode();
+
+// Accessing response headers
+$response->getHeaders();
 
 // Show response body
 echo $response->getBody();