Merge pull request #60 from coreruleset/update-readme

chore: update readme to point to docs

.github/workflows/codeql-analysis.yml

@@ -13,10 +13,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ main, develop ]
+    branches: [ main ]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main, develop ]
+    branches: [ main ]
   schedule:
     - cron: '33 8 * * 4'
 

.github/workflows/regression.yml

@@ -4,13 +4,16 @@ on:
   push:
     branches:
       - main
-    paths-ignore:
-      - "**/*.md"
-      - "LICENSE"
+  # Currently, there doesn't appear to be a simple solution for
+  # having required checks with ignored paths (the checks will
+  # never run and so PRs cannot be merged).
+  #   paths-ignore:
+  #     - "**/*.md"
+  #     - "LICENSE"
   pull_request:
-    paths-ignore:
-      - "**/*.md"
-      - "LICENSE"
+  #   paths-ignore:
+  #     - "**/*.md"
+  #     - "LICENSE"
 
 jobs:
   test:

README.md

@@ -1,3 +1,3 @@
 # crs-toolchain
 
-Based on experiment in Python with rassemble-go backend: https://github.com/theseion/coreruleset/tree/rassemble-backend
+The CRS developer's utility belt. The documentation lives at [coreruleset.org](https://coreruleset.org/docs/development/crs_toolchain/).