Merge pull request #160 from rocketstack-matt/spectral-docs

Minor updates to the Spectral README
finos · Apr 22, 2024 · c7170ed · c7170ed
2 parents aca4934 + fc1b195
commit c7170ed
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/spectral/README.md b/spectral/README.md
@@ -1,5 +1,5 @@
-# Spectral validation rules for AasC implementations
-These rules perform simple structural checks on Architecture-as-Code implementation files to verify that they make sense semantically.
+# Spectral validation rules for CALM implementations
+These rules perform simple structural checks on CALM implementation files to verify that they make sense semantically.
 For example, if a relationship references a node, then that node should exist in the file.
 
 ## Installing spectral
@@ -25,5 +25,8 @@ spectral lint --ruleset aac.yaml implementation.json
 For example, to run the rulesets against the sample spec, which should produce several errors:
 
 ```bash
-spectral lint --ruleset aac.yaml examples/bad-rest-api.json
-```
+spectral lint --ruleset ./instantiation/validation-rules.yaml ./examples/bad-rest-api.json
+```
+
+## Learn more
+See the [Spectral documentation](https://docs.stoplight.io/docs/spectral/674b27b261c3c-overview) for more information on how to configure the Spectral rules.