aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Pooley (@zuedev) <zuedev@gmail.com>2026-01-23 18:31:28 +0000
committerAlex Pooley (@zuedev) <zuedev@gmail.com>2026-01-23 18:31:28 +0000
commitb9d3138f651774a2bd922fe040dbae6850ebb37d (patch)
treea455f837711a3400f7086fe480a7f50def237d81
parent7bbcb435578366fec1642cadacac3a03fe0f3889 (diff)
downloadgitinfo-b9d3138f651774a2bd922fe040dbae6850ebb37d.tar
gitinfo-b9d3138f651774a2bd922fe040dbae6850ebb37d.tar.gz
gitinfo-b9d3138f651774a2bd922fe040dbae6850ebb37d.tar.bz2
gitinfo-b9d3138f651774a2bd922fe040dbae6850ebb37d.tar.xz
gitinfo-b9d3138f651774a2bd922fe040dbae6850ebb37d.zip
Add icon key to .gitinfo example and documentation
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index b976405..1973bfd 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,7 @@ The `.gitinfo` file uses JSONC (JSON with Comments) format, allowing for easy re
{
"root": "https://github.com/example/repository",
"gitmail": "patches@example.com",
+ "icon": "https://example.com/icon.png",
"description": "Example repository description",
"tags": ["example", "repository", "gitinfo"],
"mirrors": [
@@ -34,6 +35,7 @@ The `.gitinfo` file uses JSONC (JSON with Comments) format, allowing for easy re
- `root`: The URL of the root repository. This key is mandatory and should point to the main hosting location of the repository that acts as the source of truth for the codebase.
- `gitmail`: An email address associated with the repository for submitting git patches. See [git-send-email.io](https://git-send-email.io/) for details.
+- `icon`: A public URL or data URI formatted image (PNG, SVG, etc.) representing an icon for the repository. If using a data URI, we recommend using base64 encoding for compatibility.
- `description`: A brief description of the repository's purpose or contents.
- `tags`: A list of tags or keywords associated with the repository for easier categorization and searchability.
- `mirrors`: A list of URLs representing mirror repositories.