Skip to content

Commit

Permalink
Release 1.0 🎉
Browse files Browse the repository at this point in the history
  • Loading branch information
Th3Mouk committed Sep 27, 2016
1 parent 76c5886 commit e66cc22
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,43 @@ This PHP library providing a simple way to communicate with Yahoo Weather API.

## Installation

`composer require th3mouk/yahoo-weather-api ^1.0@dev`
`composer require th3mouk/yahoo-weather-api ^1.0`

## Usage

Simply implement the class

```php
$service = new YahooWeatherAPI();
$yahooWeather = new YahooWeatherAPI();
```

### Methods

Get forecasts with a WOEID code :

```php
$service->callApiWoeid($woeid = null, $unit = 'c');
$yahooWeather->callApiWoeid($woeid = null, $unit = 'c');
```

Get forecasts with a city name :

```php
$service->callApiCityName($name = null, $unit = 'c');
$yahooWeather->callApiCityName($name = null, $unit = 'c');
```

Get forecasts with a [yql request](https://developer.yahoo.com/yql/console/) :

```php
$service->callApi($yql = null);
$yahooWeather->callApi($yql = null);
```

## Thanks
- To [Jean-Baptiste Audebert](https://github.com/jb18) for the first layer of code
- To [peter279k](https://github.com/peter279k) for testing suite

## Contributing

Before commiting, please run `php-cs-fixer fix .` command, and update the test suite.

## Please

Expand Down

0 comments on commit e66cc22

Please sign in to comment.