feat: added readme

algebratech · Feb 15, 2021 · e99ef84 · e99ef84
1 parent 65a5e60
commit e99ef84
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# dotnet scanner for pre-commit! :fire:
+
+Run **dotnet-sonarscanner** on [pre-commit](https://pre-commit.com) hooks.
+
+### Example .pre-commit-config.yaml
+
+```yaml
+repos:
+-   repo: https://github.com/algebratech/dotnet-sonar-pre-commit
+    rev: v1.0.0
+    hooks:
+    -   id: dotnet-sonarscanner
+        args: [
+            '--sonar-project-key=projectKey',
+            '--sonar-project-name=projectName',
+            '--sonar-organization=organization'
+        ]
+```