aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Pooley (@zuedev) <zuedev@gmail.com>2026-02-05 15:55:59 +0000
committerAlex Pooley (@zuedev) <zuedev@gmail.com>2026-02-05 15:55:59 +0000
commit30f2e0aca660e3742161ee7a16d72bb38eb35180 (patch)
treeca135fd6cbc67f503350aa69473e51c798b8fade /README.md
parent4057acab8851e135fb4b27c0d80740cc9d629d5d (diff)
downloadgitinfo-30f2e0aca660e3742161ee7a16d72bb38eb35180.tar
gitinfo-30f2e0aca660e3742161ee7a16d72bb38eb35180.tar.gz
gitinfo-30f2e0aca660e3742161ee7a16d72bb38eb35180.tar.bz2
gitinfo-30f2e0aca660e3742161ee7a16d72bb38eb35180.tar.xz
gitinfo-30f2e0aca660e3742161ee7a16d72bb38eb35180.zip
add example configurations for .gitinfo file
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 704c24c..827ec39 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,12 @@ You can reference the schema in your `.gitinfo` file using the `$schema` propert
}
```
+See the [`examples/`](examples/) folder for more sample configurations:
+
+- [`minimal.gitinfo`](examples/minimal.gitinfo) — Bare minimum with just a root URL
+- [`open-source-project.gitinfo`](examples/open-source-project.gitinfo) — Full-featured project with mirrors, maintainers, and funding
+- [`mirror-only.gitinfo`](examples/mirror-only.gitinfo) — Read-only mirror pointing to upstream
+
### Supported Keys
All keys are optional. Include only the fields relevant to your project.