Skip to content

Commit

Permalink
Merge pull request #27 from codeclimate/abh-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
Ashley Baldwin-Hunter committed Feb 11, 2016
2 parents c3ca9c1 + e2e02f3 commit b3181b9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Code Climate FIXME Engine

`codeclimate-fixme` is a Code Climate engine that finds comments in your code which match the following strings:
`codeclimate-fixme` is a Code Climate engine that performs a case-sensitive search for the following strings in your project:

* `TODO`
* `FIXME`
* `HACK`
* `BUG`
* `XXX`

These strings are things you should fix now, not later.

Expand Down

0 comments on commit b3181b9

Please sign in to comment.