docs: add example

CircleCI-Public · Jul 14, 2023 · 74bd117 · 74bd117
1 parent 89ee3c2
commit 74bd117
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 13 deletions.
diff --git a/src/examples/example.yml b/src/examples/example.yml
diff --git a/src/examples/lint_workflow.yml b/src/examples/lint_workflow.yml
@@ -0,0 +1,10 @@
+description: >
+  The `vale/lint` job can be added to your existing workflows or as a new workflow to lint your markdown, AsciiDoc, reStructuredText, and more.
+usage:
+  version: 2.1
+  orbs:
+    vale: circleci/vale@1.0.0
+  workflows:
+    lint:
+      jobs:
+        - vale/lint