README.md in danger-todoist-0.2.0 vs README.md in danger-todoist-0.3.0

- old
+ new

@@ -13,35 +13,51 @@ Methods and attributes from this plugin are available in your `Dangerfile` under the `todoist` namespace. ### todoist -<blockquote>Ensure there are no TODOS left in the modified code +This is a danger plugin to detect any TODO/FIXME entries left in the code. + +<blockquote>Ensure, by warning, there are no TODOS left in the modified code <pre> todoist.warn_for_todos</pre> </blockquote> -<blockquote>Set custom warning message +<blockquote>Ensure, by failing the build, no TODOS left in the modified code <pre> -todois.message = "Please fix all TODOS" +todoist.fail_for_todos</pre> +</blockquote> + +<blockquote>Set custom warning message for warning + <pre> +todoist.message = "Please fix all TODOS" todoist.warn_for_todos</pre> </blockquote> <blockquote>List every todo item <pre> todoist.warn_for_todos todoist.print_todos_table</pre> </blockquote> +<blockquote>Do anything with the todos. Todos have `text` and `file` properties + <pre> +todoist.todos.each { |todo| puts todo.text }</pre> +</blockquote> + #### Attributes `message` - Message to be shown #### Methods `warn_for_todos` - Adds a warning if there are todos found in the modified code +`fail_for_todos` - Adds an error if there are todos found in the modified code + `print_todos_table` - Adds a list of offending files to the danger comment + +`todos` - Returns the list of todos in the current diff set ## Development 1. Clone this repo 2. Run `bundle install` to setup dependencies.