docs: Add badges and screenshot to readme. (#103)

Adds badges for the PR workflows and the package version. Adds a screenshot of the main dashboard with a single metric. Addresses #100
DevoteamNL · Nov 15, 2023 · d43ba3b · d43ba3b
1 parent d473a22
commit d43ba3b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,12 @@
 
 This repo contains all the projects needed to start development on the OpenDORA backstage plugin for DORA metrics.
 
+![Backstage Plugin](.github\workflows\pr-backstage-plugin-workflow.yaml/badge.svg)
+![API](.github\workflows\pr-go-workflow.yaml/badge.svg)
+[![Plugin version](https://img.shields.io/github/package-json/v/devoteamnl/opendora?label=plugin&filename=backstage-plugin%2Fplugins%2Fopen-dora%2Fpackage.json)](https://www.npmjs.com/package/@devoteam-nl/open-dora-backstage-plugin)
+
+![Screenshot of the main OpenDORA dashboard](screenshot.png)
+
 ## Contents
 
 ### dora-api-mock

diff --git a/screenshot.png b/screenshot.png