README.md in reviewer-0.1.1 vs README.md in reviewer-0.1.2
- old
+ new
@@ -1,9 +1,29 @@
+**Note:** As of May 4th, 2021, Reviewer is a work in progress and does not actually do anything just yet. Hopefully soon.
+
# Reviewer
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/reviewer`. To experiment with that code, run `bin/console` for an interactive prompt.
+Reviewer reduces the friction of using automated tools for dependency audits, static analysis, linting, testing, and more by providing a standardized way to configure and run them in different contexts with less friction.
-TODO: Delete this and the text above, and describe your gem
+So, instead of...
+```
+yarn audit --level moderate
+bundle exec bundle-audit check --no-update
+bundle exec rubocop --parallel
+bundle exec erblint --lint-all --enable-all-linters
+yarn stylelint .
+yarn eslint .
+bundle exec rake notes
+```
+
+You run...
+```
+./bin/rvw
+```
+
+Having a simpler command is just the beginning through. It also cleans up the output and lets you run subsets of commands.
+
+For more detailed information, take a look at the [Overview](https://github.com/garrettdimon/reviewer/wiki/Overview) and [Usage](https://github.com/garrettdimon/reviewer/wiki/Usage) pages in the wiki.
## Installation
Add this line to your application's Gemfile: