Update README.md included Syntax Highlighting for VS Code (#6)

dmytrostriletskyi · Sep 12, 2023 · f7682bb · f7682bb
1 parent 5b4e9b7
commit f7682bb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.project-version b/.project-version
@@ -1 +1 @@
-0.0.3
+0.0.4
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ Table of content:
   * [Examples](#examples)
   * [Syntax Highlighting](#syntax-highlighting)
     * [PyCharm](#pycharm)
+    * [VSCode](#vs-code)
 * [Usage](#usage)
   * [Command Line Interface](#command-line-interface)
   * [Guide](#guide)
@@ -135,6 +136,14 @@ As a result, you will experience syntax highlighting when typing:
   ![](./assets/syntax-highlight.png)
 </details>
 
+#### VS Code
+
+For `VS Code`, install the [RedHat YAML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) extension and include the following line in the top of your diagrams yaml file:
+
+```yaml
+# yaml-language-server: $schema=https://raw.githubusercontent.com/dmytrostriletskyi/diagrams-as-code/main/json-schemas/0.0.1.json
+```
+
 ## Usage
 
 ### Command Line Interface