Hi-Folks / milk-sdk-php

Milk SDK PHP is a (fluent) open-source PHP library that makes it easy to integrate your PHP application with location services like Geocode, Route, Isoline, Search Places and Address, location data ...
https://packagist.org/packages/hi-folks/milk-sdk-php
MIT License
7 stars 12 forks source link

Improve documentation for Weather API in readme.md #78

Closed roberto-butti closed 2 years ago

roberto-butti commented 3 years ago

In readme.md file, in Weather API section, add some information about Weather class methods like:

Considering these notes:

     * Set the product for the Weather API
     * A parameter identifying the type of report to obtain.
     * The possible values are as follows:
     * - observation – current weather conditions from the eight closest locations to the specified location
     * - forecast_7days – morning, afternoon, evening and night weather forecasts for the next seven days.
     * - forecast_7days_simple – daily weather forecasts for the next seven days
     * - forecast_hourly – hourly weather forecasts for the next seven days
     * - forecast_astronomy – information on when the sun and moon rise and set,
     * and on the phase of the moon for the next seven days
     * - alerts – forecasted weather alerts for the next 24 hours
     * - nws_alerts – all active watches and warnings for the US and Canada
ckbball commented 3 years ago

Do you have a style guideline?

roberto-butti commented 3 years ago

Hi @ckbball , I don't have a styleguide. But you can follow as example https://github.com/Hi-Folks/milk-sdk-php#map-image-api Map Image Api in the readme file, where I explained the goal of the class and I listed the most relevant methods with bullet point.