From 2cddcef7015eb21b62e46b62760e0caf0803e1ad Mon Sep 17 00:00:00 2001 From: Carlos Martinez Ledo Date: Mon, 5 Mar 2018 18:31:34 -0300 Subject: [PATCH] Minor README improvements --- README.md | 52 ++++++++++++++++++++++++++-------------------------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 4d60110..53a360f 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ -#OGetIt +# OGetIt OGetIt is a open source library for handling the new OGame API as of version 6. It handles everything from connecting with the API, parsing the API to advanced calculations to get detailed results. -##Supported features -###Reports +## Supported features +### Reports * Combat * Harvest * Espionage * Missile -##How to use? - +## How to use? +```php include('autoload.php'); //Or via Composer $ogetit = new OGetIt($uni, $lang, $apikey); @@ -27,41 +27,41 @@ It handles everything from connecting with the API, parsing the API to advanced //Get Missile report $mr = $ogetit->getMissileReport($mrkey); - -###Examples -####Get attacker losses from combat report - +``` +### Examples +#### Get attacker losses from combat report +```php $cr = $ogetit->getCombatReport($crkey); $result = $cr->getCalculator()->getFinalResult(); $result->getAttackers()->getLosses(); - -####Get harvested metal from harvest report - +``` +#### Get harvested metal from harvest report +```php $rr = $ogetit->getHarvestReport($rrkey); $rr->getMetal(); - -####Get Astrophysics level from espionage report - +``` +#### Get Astrophysics level from espionage report +```php $sr = $ogetit->getSpyReport($srkey); $sr->getDefender()->getResearch()[Astrophysics::TYPE]; - -####Get defender losses from missile report - +``` +#### Get defender losses from missile report +```php $mr = $ogetit->getMissileReport($mrkey); $mr->getDefender()->getLosses(); - -##Requirements +``` +## Requirements * PHP v5.4+ (64-bit) * PHP cURL (libcurl v7.10.5+) -##Exceptions +## Exceptions -###cURL codes +### cURL codes http://curl.haxx.se/libcurl/c/libcurl-errors.html -###OGame API codes +### OGame API codes OK = 1000; INVALID_VERSION = 4000; @@ -72,13 +72,13 @@ http://curl.haxx.se/libcurl/c/libcurl-errors.html INTERNAL_ERROR = 5000; INVALID_CR_ID = 6000; -##Contributing +## Contributing If you want to contribute code please fork this repository and create a pull request to merge your changes. Your changes will be reviewed and merged afterwards if approved by the repository maintainers. -##License +## License GNU Lesser General Public License, version 2.1 -* License: [GNU LGPL](COPYING) \ No newline at end of file +* License: [GNU LGPL](COPYING)