README.md in safe_pusher-0.2.1 vs README.md in safe_pusher-0.2.2
- old
+ new
@@ -1,38 +1,39 @@
-# SafePusher
-
[![Build Status](https://travis-ci.com/williampollet/safe_pusher.svg?branch=master)](https://travis-ci.com/williampollet/safe_pusher)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1aa6c275f9ce4d4c6ec3/maintainability)](https://codeclimate.com/github/williampollet/safe_pusher/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1aa6c275f9ce4d4c6ec3/test_coverage)](https://codeclimate.com/github/williampollet/safe_pusher/test_coverage)
-Run your favorite linters and specs on the files you touched, before pushing your branch
+# SafePusher
+Run your favorite linters and specs on the files you touched, before pushing your branch.
+
## Installation
-Add this line to your application's Gemfile:
+Add these lines to your application's Gemfile:
```ruby
-gem 'safe_pusher'
+# Lint and launch specs before pushing.
+gem 'safe_pusher', require: false
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install safe_pusher
-
To use the gem fully, you should install [pronto](https://github.com/prontolabs/pronto) and [rspec](https://github.com/rspec/rspec) first.
## Configuration
-Generate the `binstubs` for `pronto` and `rspec`:
+Generate the `binstubs` for `pronto`, `rspec` and `safepush`:
- $ bundler binstubs pronto
- $ bundler binstubs rspec-core
+ $ bundler binstubs pronto rspec-core safe_pusher
-create the `safe_pusher.yml` file at the root of your application
+Create the `safe_pusher.yml` file at the root of your application:
```yaml
files_to_skip:
- file/to/skip_1
- file/to/skip/2
@@ -44,16 +45,24 @@
To see the commands available, type:
$ safepush
-To run pronto checks before to push on github run:
+To run pronto checks before you push to GitHub run:
- $ safepush ppush
+ $ safepush lint_push_and_open
-To run specs and pronto before to push on github run:
+or
- $ safepush ppushtest
+ $ safepush lpo
+
+To run specs and pronto before you push to GitHub run:
+
+ $ safepush test_lint_push_and_open
+
+or
+
+ $ safepush tlpo
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/williampollet/safe_pusher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.