Merge pull request #4 from UBC-MDS/feat-update-documentation-files

Feat update documentation files

CONTRIBUTING.md

@@ -3,6 +3,12 @@
 Contributions are welcome, and they are greatly appreciated! Every little bit
 helps, and credit will always be given.
 
+Current contributors include:
+- [Christopher Alexander](https://github.com/christopheralex) - christopher.a0@gmail.com
+- [Daniel King](https://github.com/danfke) - dnlkng13@gmail.com
+- [Mel Liow](https://github.com/mel-liow) - mel.liow.94@gmail.com
+
+Please feel free to connect or contact us if there are any queries.
 ## Types of Contributions
 
 ### Report Bugs

README.md

@@ -1,6 +1,32 @@
 # AirPyllution
+A package for visualizing or obtaining future, historic and current air pollution data using the [OpenWeather API](https://openweathermap.org).
 
-A package which  provides various functionalities on air pollution data.
+## Summary
+This package enables users to explore air pollution levels in locations around the world.
+Using the [Air Pollution API](https://openweathermap.org/api/air-pollution), this package provides 3 functions that help to visualise present, future and historic air pollution data.  
+
+The data returned from the API includes the polluting gases such as Carbon monoxide (CO), Nitrogen monoxide (NO), Nitrogen dioxide (NO2), Ozone (O3), Sulphur dioxide (SO2), Ammonia (NH3), and particulates (PM2.5 and PM10).
+
+Using the OpenWeatherMap API requires sign up to gain access to an API key.  
+This API key should be stored in the `config.py` file. (TO ADD)  
+For more information about API call limits and API care recommendations please visit the [OpenWeather how to start](https://openweathermap.org/appid) page.
+## Functions
+The functions are as follows:
+- `getAirPollution()`
+- `getPollutionHistory()`
+- `getPollutionForecast()`
+
+### `getAirPollution()`
+Fetches the air pollution levels based on a location (string). Based on the values of the polluting gases, this package uses the [Air Quality Index](https://en.wikipedia.org/wiki/Air_quality_index#CAQI) to determine the level of pollution for the location and produces a coloured map of the area displaying the varying regions of air quality.
+
+### `getPollutionHistory()`
+Requires a start and end date and fetches historic air pollution data for a specific location. The function returns a data frame with the values of the polluting gases over the specified date range.
+
+### `getPollutionForecast()`
+Fetches air pollution data for the next 5 days for a specific location. The function returns a time series plot of the predicted pollution levels.
+
+
+Although there is an abundance of python weather packages and APIs in the Python ecosystem (e.g. [python-weather](https://pypi.org/project/python-weather/), [weather-forecast](https://pypi.org/project/weather-forecast/)), this particular package looks at specifically air pollution data and uses the Air Pollution API from OpenWeather. This is a unique package with functionality that (we believe) has not been made before.
 
 ## Installation