Add README.md

lgcbx · Jul 16, 2020 · 2e843ce · 2e843ce
1 parent ce75a42
commit 2e843ce
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# Rails Best Practices Action
+
+GitHub Action that lints your Ruby on Rails code with the [rails_best_practices](https://github.com/flyerhzm/rails_best_practices) gem
+
+## Inputs
+
+None
+
+## Outputs
+
+None
+
+## Example usage
+
+```
+uses: docker://lgcbx/rails_best_practices-action:v1.20.0
+```
+
+OR
+
+```
+uses: lgcbx/rails_best_practices-action@v1.20.0
+```