Skip to content

Commit

Permalink
Merge pull request #45 from codeclimate/abh-readme-docs-link
Browse files Browse the repository at this point in the history
link to codelcimate docs in readme
  • Loading branch information
Ashley Baldwin-Hunter committed Jan 13, 2016
2 parents 9523ce2 + da60ff0 commit 3c6f4ea
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

RuboCop helps you enforce many of the guidelines outlined in the community [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide). Most aspects of its behavior can be tweaked via various [configuration options](https://github.com/bbatsov/rubocop/blob/master/config/default.yml), which are set in a **.rubocop.yml** file.

You can find some basic setup instructions and links to the RuboCop OSS project below. For additional Code Climate-specific config details, check out our [RuboCop engine documentation][cc-docs-rubocop].

### Installation

1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
Expand All @@ -16,4 +18,6 @@ RuboCop helps you enforce many of the guidelines outlined in the community [Ruby

For help with RuboCop, [check out their documentation](https://github.com/bbatsov/rubocop).

If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
If you're running into a Code Climate issue, first check out [our RuboCop engine docs][cc-docs-rubocop] and look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-rubocop/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).

[cc-docs-rubocop]: https://docs.codeclimate.com/docs/rubocop

0 comments on commit 3c6f4ea

Please sign in to comment.