renuo-bin-check 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 202e3b412e3df80b06111b7b2b2258216bb6d787
-  data.tar.gz: 6e5b397dbb112bd0815246f5f87b86f4f8d42a01
+  metadata.gz: ff44c0cca4c757a3b2217a89ace55403cf337e9d
+  data.tar.gz: 7961ea8b231c3066b7424b41e78fef4528308f8f
 SHA512:
-  metadata.gz: 8370dcb55c014cc6037104c61a5075393e1ac886ca6b886a81860d4801ced4c4d763e26c1558124cacf7e80001c3e78b1bb02913be071430b7cd47b3f0177a46
-  data.tar.gz: e204c67f5f9b2d2a5914f1da1aba397fe12228f24d16b1210ee1ca99840eb785223848e812632bb01a6d542e46afcb1dfe1161f069ce32cf67df11d7e68c993d
+  metadata.gz: cef222fd0620af85910bca2755a36a47ad6adb8bb0a2c9b93bcf9455cd0c5f100c30db793bb8878e0982312de493c5f9c3065f9cfa5dd5814b789a2594424955
+  data.tar.gz: 67242eb0cddc9323f27ae1652fd9d401d5677eeffd496c7b2e12bc808c2fd83c912784706a7f0729c63987ee7adc509e7e668898d0380d0054a1591d98a0448a

data/CHANGELOG.md

@@ -34,3 +34,8 @@ This was implemented as many Scripts use the Standard-Output for Outputs even if
 * Error-Output can be appended or overridden
 
 * Default-Script for faster Configuration of a bin/check in rails applications
+
+## Version 0.2.1
+
+* fixed typos
+* refined readme

data/README.md

@@ -1,44 +1,23 @@
 [![Build Status](https://travis-ci.org/renuo/renuo-bin-check.svg?branch=master)](https://travis-ci.org/renuo/renuo-bin-check) [![Build Status](https://travis-ci.org/renuo/renuo-bin-check.svg?branch=develop)](https://travis-ci.org/renuo/renuo-bin-check)  [![Build Status](https://travis-ci.org/renuo/renuo-bin-check.svg?branch=testing)](https://travis-ci.org/renuo/renuo-bin-check) [![Code Climate](https://codeclimate.com/github/renuo/renuo-bin-check/badges/gpa.svg)](https://codeclimate.com/github/renuo/renuo-bin-check) [![Issue Count](https://codeclimate.com/github/renuo/renuo-bin-check/badges/issue_count.svg)](https://codeclimate.com/github/renuo/renuo-bin-check) [![Test Coverage](https://codeclimate.com/github/renuo/renuo-bin-check/badges/coverage.svg)](https://codeclimate.com/github/renuo/renuo-bin-check/coverage)
-# renuo-bin-check
-
-## Setup
-
-```
-git clone git@github.com:renuo/renuo-bin-check.git
-cd renuo-bin-check
-bin/setup
-```
-
-## Run Tests
 
-The following script will run rspec, rubocop, reek, scanner for debugging outputs and a scanner for TODOs
-
-```
-bin/check
-```
-
-Run automated tests only with: `rspec`
-
-Run Lining only: `rubocop`
+# renuo-bin-check
 
-Run Code Smell detector only: `reek``
+With this gem you can automatically check your code quality (e.g. before every commit).
+You can configure it to run [*rubocop*][1], [*reek*](2), [*rspec*](3) and even custom scripts.
+For faster runtime it makes use of caching and parallel execution.
 
 ## How To Use renuo-bin-check
 
-Install renuo-bin-check locally: see Setup
-
 Add renuo-bin-check to your Gemfile:
 
 ```rb
-gem 'renuo-bin-check', path: '<path-to-renuo-bin-check>'
+gem 'renuo-bin-check'
 ```
 
-Create a file at any place you want. Usually it would be called bin/check though.
-
+Create a file at any place you want. Usually it would be called `bin/check though.
 You can now configure your scripts like that:
 
 ```rb
-# Initialize bin-check
 require 'renuo-bin-check'
 
 bin_check = RenuoBinCheck::Initializer.new
@@ -51,11 +30,25 @@ bin_check.check do |config|
   config.reversed_exit <true or false>
 end
 
-#run everything
+#run all scripts configured above
 bin_check.run
 ```
 
-### Options
+## Setup
+
+    git clone git@github.com:renuo/renuo-bin-check.git
+    cd renuo-bin-check
+    bin/setup
+
+
+## Run Tests
+
+The following script will run *rspec*, *rubocop*, *reek*, scanner for debugging outputs and a scanner for TODOs
+
+    bin/check
+
+
+### Options for Configuration
 
 #### command
 
@@ -129,14 +122,22 @@ If you would like to contribute, you're very welcome to.
 
 Please follow these instructions:
 
-https://github.com/renuo/renuo-bin-check/blob/develop/CONTRIBUTING.md
-
-https://github.com/renuo/renuo-bin-check/blob/develop/CODE_OF_CONDUCT.md
+* [Contributing][4]
+* [Code of Conduct][5]
 
 ## License
 
-Copyright (c) 2016 Renuo GmbH
+Copyright (c) 2016 [Renuo GmbH]
+
+[MIT License][6]
+
+
+[1]: https://github.com/bbatsov/rubocop
+[2]: https://github.com/troessner/reek
+[3]: https://github.com/rspec/rspec
 
-MIT License
+[4]: https://github.com/renuo/renuo-bin-check/blob/develop/CONTRIBUTING.md
+[5]: https://github.com/renuo/renuo-bin-check/blob/develop/CODE_OF_CONDUCT.md
+[6]: https://github.com/renuo/renuo-bin-check/blob/develop/LICENSE
 
-Read more: https://github.com/renuo/renuo-bin-check/blob/develop/LICENSE
+[Renuo GmbH]: https://www.renuo.ch

data/lib/renuo_bin_check/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RenuoBinCheck
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/renuo-bin-check.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email = ['zora.fuchs@renuo.ch']
 
   spec.summary = 'renuo-bin-check automates running programms to check code quality of a ruby application.'
-  spec.description = 'With this gem you can automatically check your code quality (e.g. before every commit). You can configure it to run rubocop, reek, rspec and even custom scripts. For faster runtime it makes use of cashing and parallel execution.'
+  spec.description = 'With this gem you can automatically check your code quality (e.g. before every commit). You can configure it to run rubocop, reek, rspec and even custom scripts. For faster runtime it makes use of caching and parallel execution.'
   spec.homepage = 'https://github.com/renuo/renuo-bin-check'
   spec.license = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: renuo-bin-check
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Zora Fuchs
@@ -180,7 +180,7 @@ dependencies:
         version: '0.11'
 description: With this gem you can automatically check your code quality (e.g. before
   every commit). You can configure it to run rubocop, reek, rspec and even custom
-  scripts. For faster runtime it makes use of cashing and parallel execution.
+  scripts. For faster runtime it makes use of caching and parallel execution.
 email:
 - zora.fuchs@renuo.ch
 executables: []