aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Pooley (@zuedev) <zuedev@gmail.com>2026-02-05 15:35:25 +0000
committerAlex Pooley (@zuedev) <zuedev@gmail.com>2026-02-05 15:35:25 +0000
commitbb233880b1f319e1a911edb80355757e3732645d (patch)
treecb2d951a5eb67426d8c3bc231b6950cbe0b114d4 /README.md
parentb9d3138f651774a2bd922fe040dbae6850ebb37d (diff)
downloadgitinfo-bb233880b1f319e1a911edb80355757e3732645d.tar
gitinfo-bb233880b1f319e1a911edb80355757e3732645d.tar.gz
gitinfo-bb233880b1f319e1a911edb80355757e3732645d.tar.bz2
gitinfo-bb233880b1f319e1a911edb80355757e3732645d.tar.xz
gitinfo-bb233880b1f319e1a911edb80355757e3732645d.zip
add json schema
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1973bfd..e81e102 100644
--- a/README.md
+++ b/README.md
@@ -10,10 +10,21 @@ The `.gitinfo` file is a simple text file that can be placed in the root directo
The `.gitinfo` file uses JSONC (JSON with Comments) format, allowing for easy readability and the inclusion of comments. The file consists of key-value pairs, where each key represents a specific piece of metadata about the repository.
+### Validation
+
+A JSON Schema is available for validating `.gitinfo` files:
+
+```
+https://raw.githubusercontent.com/zuedev/gitinfo/main/gitinfo.schema.json
+```
+
+You can reference the schema in your `.gitinfo` file using the `$schema` property for editor autocompletion and validation support.
+
### Example `.gitinfo` File
```jsonc
{
+ "$schema": "https://raw.githubusercontent.com/zuedev/gitinfo/main/gitinfo.schema.json",
"root": "https://github.com/example/repository",
"gitmail": "patches@example.com",
"icon": "https://example.com/icon.png",