commit f09e7c5bc7b25cbbc52c6f6e4f7665b892fab143 parent 56559bf2fc74ff035e0a9221756bd49969d08b17 Author: Stefan Koch <programming@stefan-koch.name> Date: Fri, 1 May 2020 10:47:38 +0200 add docs for badges feature Diffstat:
| M | README.md | | | 15 | +++++++++++++++ |
1 file changed, 15 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -198,6 +198,21 @@ repository in cleartext, but as soon as your server is compromised all your credentials are compromised. +Badges +------ + +It's possible to generate build success/failure badges that can be displayed +on websites. To enable this feature add the following configuration: + +```toml +[dashboard] +folder = "/var/www/cinderella" +``` + +The build process will then write the badges into `folder`. Serving the data +via HTTP is your own responsibility, use any web server of your choice. + + Open Points -----------