README.md in java-checkstyle-0.0.2 vs README.md in java-checkstyle-1.0.0
- old
+ new
@@ -1,29 +1,41 @@
## Java - Pre-Commit Checkstyle
+[![Gem Version](https://badge.fury.io/rb/java-checkstyle.svg)](https://badge.fury.io/rb/java-checkstyle)
[![Build Status](https://travis-ci.org/CristianOliveiraDaRosa/java-checkstyle.svg?branch=dev)](https://travis-ci.org/CristianOliveiraDaRosa/java-checkstyle)
[![Code Climate](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle/badges/gpa.svg)](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle)
[![Test Coverage](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle/badges/coverage.svg)](https://codeclimate.com/github/CristianOliveiraDaRosa/java-checkstyle/coverage)
-[Checkstyle](http://checkstyle.sourceforge.net/) linter plugin for [pre-commit](https://github.com/jish/pre-commit). Useful for linting Java code.
+Useful pre-commit hook for linting Java code. It uses as default [The Google Style Guide](https://google.github.io/styleguide/javaguide.html)
+It uses the famous [Checkstyle](http://checkstyle.sourceforge.net/) linter as a plugin for [pre-commit](https://github.com/jish/pre-commit).
+
+## Demo
+
+![My awesome change has been catch. Oh boy!](https://raw.githubusercontent.com/CristianOliveiraDaRosa/java-checkstyle/master/readmedemo.png)
+
## Installation
-Add this line to your application's Gemfile:
+First install the gems.
+### Pre-Commit Checkstyle
- gem 'pre-commit-checkstyle'
+ gem install pre-commit
-And then execute:
+### Java Checkstyle Plugin
- $ bundle
+ gem install java-checkstyle
-Or install it yourself as:
+### Configuring
+Use the pre-commit command to generate a stub pre-commit hook.
+Inside folder of your git repo:
- $ gem install pre-commit-checkstyle
+```bash
+pre-commit install
+```
-## Usage
+It will create a .git/hooks/pre-commit script which will check your git config and run checks that are enabled.
-Make sure the gem is installed and setup the check in [pre-commit](https://github.com/jish/pre-commit) with:
+### Enabling checks
``` bash
pre-commit enable git checks checkstyle
```
@@ -31,16 +43,66 @@
``` bash
pre-commit enable yaml checks checkstyle
```
+### Result
+Every time you try to commit some java code with style errors it will validate
+before.
+
+---
+#### Detailed version to install.
+Still don't work? Try the detailed version [here](https://github.com/CristianOliveiraDaRosa/java-checkstyle/blob/master/DETAILED_TUTORIAL.md)
+
+---
+
+## Installing with RVM
+
+If you are using rvm you need to install pre-commit into the ```default``` gemset, because it does not use the ```current``` environment
+
+ $ rvm default do gem install pre-commit
+
+Alternatively you can configure pre-commit to use the ```current``` rvm gemset
+
+ $ git config pre-commit.ruby "rvm `rvm current` do ruby"
+
+More details about this part see on:
+[pre-commit](https://github.com/jish/pre-commit)
+
+And your pre-commit hook has been configured.
+
+## Checkstyle Guide
+
+It uses as default [The Google Style Guide](https://google.github.io/styleguide/javaguide.html).
+
+## Tests
+Running tests with rspec
+
+Make sure you have been executed:
+```bash
+bundle install
+```
+Then run:
+
+```bash
+rspec
+```
+
## Contributing
-1. Fork it ( http://github.com/secondrotation/pre-commit-checkstyle/fork )
+1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+#### Codeclimate
+Before push, make sure you have been executed rubocop
+``` bash
+rubocop lib/*
+```
+
+*Pull request should have Unit Tests*
## Authors:
- Allen Madsen (Original Version 0.0.1)
- Alex Rocha
- Cristian Oliveira