aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDrew DeVault <sir@cmpwn.com>2019-02-08 08:26:57 -0500
committerDrew DeVault <sir@cmpwn.com>2019-02-08 08:26:57 -0500
commit810f27cf46f6c9f4753ecc8c2d3c9891986a475a (patch)
treecdbde54ffb034d03bbe3115016ecf21a1b95ab3a
parentdfb5b58d8587470cdbdbc97792892b5e464f47bb (diff)
downloadsr.ht-docs-810f27cf46f6c9f4753ecc8c2d3c9891986a475a.tar.gz
Document build status badges
-rw-r--r--builds.sr.ht/index.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/builds.sr.ht/index.md b/builds.sr.ht/index.md
index 005778d..5fe928d 100644
--- a/builds.sr.ht/index.md
+++ b/builds.sr.ht/index.md
@@ -97,6 +97,18 @@ The actual shell varies depending on your build image. `~/.buildenv` contains
the environment variables you specified in your manifest, but feel free to
modify it to communicate state between build steps.
+# Build status badges
+
+If you add tags to your build, or enter search terms, you can use these to
+create a build status badge like this (the example being the latest status of
+builds.sr.ht itself):
+
+[![builds.sr.ht status](https://builds.sr.ht/~sircmpwn/builds.sr.ht.svg)](https://builds.sr.ht/~sircmpwn/builds.sr.ht?)
+
+The image URL and a markdown snippet are shown in the sidebar of the [search
+results page](https://builds.sr.ht/~sircmpwn?search=scheduled+image+refresh) or
+[tag detail page](https://builds.sr.ht/~sircmpwn/builds.sr.ht).
+
# Integrations
Do you have something that integrates with builds.sr.ht? Submit a patch for this