octolab/Cleaner

View on GitHub
README.md

Summary

Maintainability
Test Coverage
> # Cleaner [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Composer%20plugin%20for%20removing%20development%20files&url=https://github.com/octolab/Cleaner&via=ikamilsk&hashtags=php,composer,cleaner)
> [![Analytics](https://ga-beacon.appspot.com/UA-109817251-3/Cleaner/readme?pixel)](https://github.com/octolab/Cleaner)
> [Composer](https://getcomposer.org) plugin for removing development files.

[![Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/octolab)
[![Build Status](https://travis-ci.org/octolab/Cleaner.svg?branch=master)](https://travis-ci.org/octolab/Cleaner)
[![Code coverage](https://scrutinizer-ci.com/g/octolab/Cleaner/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/octolab/Cleaner/?branch=master)
[![Scrutinizer code quality](https://scrutinizer-ci.com/g/octolab/Cleaner/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/octolab/Cleaner/?branch=master)
[![Code Climate code quality](https://codeclimate.com/github/octolab/Cleaner/badges/gpa.svg)](https://codeclimate.com/github/octolab/Cleaner)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

## [Documentation](docs)

## Installation

### Git (development)

[Fork it before](https://github.com/octolab/Cleaner/fork).

```bash
$ git clone git@github.com:<your github account>/cleaner.git
$ cd cleaner && composer install
$ git remote add upstream git@github.com:octolab/cleaner.git
```

#### Mirror

```bash
$ git remote add mirror git@bitbucket.org:kamilsk/cleaner.git
```

### Composer (production)

```bash
$ composer global require octolab/cleaner:1.0-alpha
```

### Feedback

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/octolab/Cleaner)
[![@kamilsk](https://img.shields.io/badge/author-%40kamilsk-blue.svg)](https://twitter.com/ikamilsk)
[![@octolab](https://img.shields.io/badge/sponsor-%40octolab-blue.svg)](https://twitter.com/octolab_inc)

## Notes

- tested on PHP 5.3, 5.4, 5.5, 5.6, 7.0, 7.1 and 7.2
- made with ❤️ by [OctoLab](https://www.octolab.org/)