From fea08a344e600159d183a33f4159e28b4e1d1b8c Mon Sep 17 00:00:00 2001 From: Youwen Wu Date: Wed, 26 Jun 2024 18:02:25 -0700 Subject: [PATCH] docs(readme): update instructions for schema validation --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 20cba18..1c7ec6f 100644 --- a/README.md +++ b/README.md @@ -213,27 +213,20 @@ you've set up git versioning. ### Linting dartgun.toml Optionally, you can set up linting for `dartgun.toml` to ensure that it is -configured properly. +configured properly. A [JSON schema file](./dartgun.schema.json) is provided for +validating the structure of `dartgun.toml`. -A JSON schema file is provided for validating the structure of `dartgun.toml`. -Download it from [this link](./dartgun.schema.json). +The easiest way to use it is to add this line to the top of `dartgun.toml`. -Place the file in your dartgun directory, such that it looks like this: +`#:schema https://raw.githubusercontent.com/youwen5/dartgun/main/dartgun.schema.json` -``` -.dartgun/ - | machine.toml - | dartgun.toml - | dartgun.schema.json -``` - -At the top of your `dartgun.toml` file, add this line. +Example: ```toml # file: dartgun.toml # add the line below to the top of your file, like so -#:schema ./dartgun.schema.json +#:schema https://raw.githubusercontent.com/youwen5/dartgun/main/dartgun.schema.json [[dots]] location = "./nvim"