Merge pull request #69 from avioconsulting/Feature/docs

Feature/docs
avioconsulting · Nov 20, 2020 · ed58249 · ed58249
2 parents 7e4fc05 + 0518611
commit ed58249
Show file tree

Hide file tree

Showing 17 changed files with 709 additions and 21 deletions.
diff --git a/.gitignore b/.gitignore
@@ -29,3 +29,6 @@ hs_err_pid*
 
 build/
 out/
+
+# OS Files
+.DS_Store
diff --git a/README.md b/README.md
@@ -76,6 +76,9 @@ class AVIOCustomRuleConfiguration {
 
 }
 ```
+
+For a full breakdown on available rules, [check here](docs/available_rules.md).
+
 ## Code Checkout
 When cloning add the 'recurse-submodules' flag
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,3 +29,6 @@ hs_err_pid* @@
     build/
     out/
+    # OS Files
+    .DS_Store