From e49f7c895181969383c060b459bef1c96716df94 Mon Sep 17 00:00:00 2001 From: Christian Flach Date: Fri, 14 Feb 2020 12:45:30 +0000 Subject: [PATCH] Add gitpod config this commit adds support for Gitpod.io, a free automated dev environment that makes contributing and generally working on GitHub projects much easier. It allows anyone to start a ready-to-code dev environment for any branch, issue and pull request with a single click. --- .gitpod.yml | 3 +++ README.md | 11 +++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000..2da2022 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,3 @@ +tasks: + - init: composer install + command: php vendor/bin/phpunit diff --git a/README.md b/README.md index 9b6795d..f783ca4 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ A PHP 7.0+ API to retrieve and parse global weather data from This project aims to normalise the provided data and remove inconsistencies. It is not maintained by OpenWeatherMap and not an official API wrapper. +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/cmfcmf/OpenWeatherMap-PHP-API) [![Build Status](https://travis-ci.org/cmfcmf/OpenWeatherMap-PHP-Api.svg?branch=master)](https://travis-ci.org/cmfcmf/OpenWeatherMap-PHP-Api) [![license](https://img.shields.io/github/license/cmfcmf/OpenWeatherMap-PHP-Api.svg)](https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/LICENSE) [![release](https://img.shields.io/github/release/cmfcmf/OpenWeatherMap-PHP-Api.svg)](https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/releases) @@ -22,6 +23,12 @@ Contributing ============ I'm happy about every **pull request** you open and **issue** you find to help make this API **more awesome**. Please note that it might sometimes take me a while to get back to you. Feel free to ping me if I don't respond. +## GitPod + +You can use GitPod to launch a fully functional development environment right in your browser. Simply click on the following badge: + +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/cmfcmf/OpenWeatherMap-PHP-API) + ## Vagrant You can use [Vagrant](https://vagrantup.com) to kick-start your development. @@ -37,13 +44,13 @@ You can also use Docker to start developing this library. First install dependen --user $(id -u):$(id -g) \ composer install -And then execute an example: +And then execute the tests: docker run --rm --interactive --tty \ --volume $PWD:/app -w /app \ php bash - > php Examples/CurrentWeather.php + > php vendor/bin/phpunit ## Documentation