From e2e02f38e538c8216c244b57fa13a4d1574a339a Mon Sep 17 00:00:00 2001 From: ABaldwinHunter Date: Thu, 11 Feb 2016 12:12:12 -0500 Subject: [PATCH] Update readme Include `XXX` in list of target words and call out that match is case sensitive. Update description of tool behavior to clarify that strings can be found outside of comments as well. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d1dd04..5621154 100644 --- a/README.md +++ b/README.md @@ -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.