README.md in glyptodont-0.2.0 vs README.md in glyptodont-0.3.0
- old
+ new
@@ -1,17 +1,17 @@
# Glyptodont
-Use this gem if you have ever deployed code to production without doing all of
-your to-dos.
+Use this gem if you want to avoid deploying code to production without doing all
+of your to-dos.
## Introduction
All of the glyptodonts have fossilised. This is a tool to ensure that your TODOs
are eradicated before this can happen to them.
If you've ever been caught out because a TODO in production code has not been
-don, this gem is for ***you***!
+_done_, this gem is for ***you***!
## Development status [](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml)
This was written after I was bitten by a TODO not being _done_ at work. I expect
to build it into our CI pipeline and see what it catches.
@@ -51,10 +51,11 @@
```
Usage: glyptodont [options]
-d, --directory DIRECTORY Git repository to search for TODOs (default '.')
-t, --threshold TODOS Maximum number of TODOs to allow (default 10)
-m, --max-age DAYS Maximum number of days to allow TODOs to stay (default 14)
+ -k, --keywords TODO,WORDS Keywords to treat as 'TODO' (default FIXME,HACK,TODO,XXX)
--version Show version
```
## Configuration
@@ -68,10 +69,12 @@
- `max_age_in_days`: Maximum number of days to allow TODOs to stay. Can be
overridden by command-line options.
- `ignore`: List of `file_name:line_number` pairs to ignore when researching
TODOs. This may be useful if you have, for example, Spanish language text in
your project or you talk about TODOs a lot :-)
+- `keywords`: List of synonyms for TODO in your project. I've seen some
+ interesting alternatives over the years.
### _Exempli gratiā_
```yaml
---
@@ -84,10 +87,10 @@
- spec/checkers/counter_spec.rb:20
```
## Requirements
-- Ruby (tested against v2.4 and above)
+- Ruby (tested against v2.5 and above)
- Git
- CMake
## Contributing