|
1 | | -OpenWeatherMap-PHP-Api |
| 1 | +OpenWeatherMap PHP API |
2 | 2 | ====================== |
3 | | -A php api to parse weather data from [OpenWeatherMap.org](http://www.OpenWeatherMap.org). |
4 | | -The api tries to normalise and abstract the data and remove inconsistencies. |
| 3 | +A php API to retrieve and parse global weather data from |
| 4 | +[OpenWeatherMap.org](http://www.OpenWeatherMap.org). |
| 5 | +This library aims to normalise the provided data and remove some inconsistencies. |
| 6 | +This library is neither maintained by OpenWeatherMap nor their official PHP API. |
5 | 7 |
|
6 | 8 | [](https://travis-ci.org/cmfcmf/OpenWeatherMap-PHP-Api) |
7 | 9 | [](https://scrutinizer-ci.com/g/cmfcmf/OpenWeatherMap-PHP-Api/) |
8 | 10 | [](https://scrutinizer-ci.com/g/cmfcmf/OpenWeatherMap-PHP-Api/?branch=master) |
9 | 11 | [](https://insight.sensiolabs.com/projects/0addfb24-e2b4-4feb-848e-86b2078ca104) |
10 | 12 | ----------- |
11 | 13 |
|
12 | | -For example code and how to use this api, please take a look into `Examples_*.php` files and run them in your browser. |
| 14 | +For example code and how to use this API, please take a look into |
| 15 | +`Examples_*.php` files and open them in your browser. |
13 | 16 | - `Examples_Current.php` Shows how to receive the current weather. |
14 | 17 | - `Examples_Forecast.php` Shows how to receive weather forecasts. |
15 | 18 | - `Examples_History.php` Shows how to receive weather history. |
16 | 19 | - `Examples_Cache.php` Shows how to implement a cache. |
17 | 20 |
|
18 | | -**Notice:** The api is neither maintained by OpenWeatherMap, nor their official php api. |
19 | 21 |
|
20 | 22 | Contribute! |
21 | 23 | =========== |
22 | | -I'm very happy if you open **pull requests** or **issues** to help making this API **more awesome**. |
| 24 | +I'm happy about every **pull request** or **issue** you find and open to help |
| 25 | +making this API **more awesome**. |
| 26 | + |
| 27 | +You can use [Vagrant](https://vagrantup.com) to kick-start your development. |
| 28 | +Simply run `vagrant up`, `vagrant ssh` and `cd` into `/vagrant` to start |
| 29 | +developing. |
23 | 30 |
|
24 | 31 | Installation |
25 | 32 | ============ |
26 | 33 | This library can be found on [Packagist](https://packagist.org/packages/cmfcmf/openweathermap-php-api). |
27 | | -The recommended way to install this is through [composer](http://getcomposer.org). |
28 | | - |
29 | | -Edit your `composer.json` and add: |
30 | | - |
31 | | -```json |
32 | | -{ |
33 | | - "require": { |
34 | | - "cmfcmf/openweathermap-php-api": "~2.0" |
35 | | - } |
36 | | -} |
37 | | -``` |
38 | | - |
39 | | -And install dependencies: |
40 | | - |
41 | | -```bash |
42 | | -$ curl -sS https://getcomposer.org/installer | php |
43 | | -$ php composer.phar install |
44 | | -``` |
45 | | - |
| 34 | +The recommended way to install and use this is through [Composer](http://getcomposer.org). |
| 35 | +Execute `composer require "cmfcmf/openweathermap-php-api": "~2.0"` in your |
| 36 | +project root. |
46 | 37 |
|
47 | 38 | Example call |
48 | 39 | ============ |
@@ -78,9 +69,11 @@ echo $weather->temperature; |
78 | 69 |
|
79 | 70 | License |
80 | 71 | ======= |
81 | | -MIT — Please see the [LICENSE file](https://github.com/Cmfcmf/OpenWeatherMap-PHP-Api/blob/master/LICENSE) distributed with this source code for further information regarding copyright and licensing. |
82 | | - |
83 | | -**Please check out the following links to read about the usage policies and the license of OpenWeatherMap before using the service.** |
84 | | -- [OpenWeatherMap.org](http://www.OpenWeatherMap.org) |
85 | | -- [OpenWeatherMap.org/terms](http://www.OpenWeatherMap.org/terms) |
86 | | -- [OpenWeatherMap.org/appid](http://www.OpenWeatherMap.org/appid) |
| 72 | +MIT — Please see the [LICENSE file](https://github.com/Cmfcmf/OpenWeatherMap-PHP-Api/blob/master/LICENSE) |
| 73 | +distributed with this source code for further information regarding copyright and licensing. |
| 74 | + |
| 75 | +**Please check out the following official links to read about the terms, pricing |
| 76 | +and license of OpenWeatherMap before using the service.** |
| 77 | +- [OpenWeatherMap.org](http://OpenWeatherMap.org) |
| 78 | +- [OpenWeatherMap.org/terms](http://OpenWeatherMap.org/terms) |
| 79 | +- [OpenWeatherMap.org/appid](http://OpenWeatherMap.org/appid) |
0 commit comments