README.md in danger-clorox-1.1.0 vs README.md in danger-clorox-2.0.0
- old
+ new
@@ -1,5 +1,7 @@
+[](https://circleci.com/gh/barbosa/danger-clorox)
+
# Danger Clorox
A [Danger](https://github.com/danger/danger) plugin for [Clorox](https://github.com/barbosa/clorox) that runs on macOS.
## Installation
@@ -10,19 +12,32 @@
gem 'danger-clorox'
```
## Usage
-The easiest way to use is just add this to your Dangerfile:
+### Basic
+Add the following line to your Danger file to check files inside the current directory:
```rb
-clorox.directories = ["YourProject", "YourProjectNotificationExtension"]
-clorox.check_files
+clorox.check
```
+### Advanced
+
+Specify the directories where you want to run the script:
+```rb
+clorox.check ["YourProject", "YourProjectNotificationExtension"]
+```
+
+Set the script level so it displays failures/warnings in the specific markdown table
+```rb
+clorox.level = "failure"
+clorox.check ["YourProject", "YourProjectNotificationExtension"]
+```
+
## Attribution
-Original structure, sequence, and organization of repo taken from [danger-prose](https://github.com/dbgrandi/danger-prose) by [David Grandinetti](https://github.com/dbgrandi/).
+Original structure, sequence, and organization of repo taken from [danger-prose](https://github.com/dbgrandi/danger-prose) by [David Grandinetti](https://github.com/dbgrandi/) and [danger-swiftlint](https://github.com/ashfurrow/danger-swiftlint) by [Ash Furrow](https://github.com/ashfurrow/).
## License
MIT