From 62780c92acb17349a4db9f6afb980f1d8a109e49 Mon Sep 17 00:00:00 2001
From: David Tuite <david@roadie.io>
Date: Sat, 24 Oct 2020 20:41:30 +0100
Subject: [PATCH] Add annotation example in CircleCI plugin README (#3081)

* Add annotation example in CircleCI plugin README

Closes #3079

* Specify lang for highlighting
---
 plugins/circleci/README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/plugins/circleci/README.md b/plugins/circleci/README.md
index d329768514..00a39ce6c8 100644
--- a/plugins/circleci/README.md
+++ b/plugins/circleci/README.md
@@ -50,7 +50,7 @@ import { Router as CircleCIRouter } from '@backstage/plugin-circleci';
 
 4. Add proxy config:
 
-```
+```yaml
 // app-config.yaml
 proxy:
   '/circleci/api':
@@ -63,6 +63,19 @@ proxy:
 5. Get and provide `CIRCLECI_AUTH_TOKEN` as env variable (https://circleci.com/docs/api/#add-an-api-token)
 6. Add `circleci.com/project-slug` annotation to your component-info.yaml file in format <git-provider>/<owner>/<project> (https://backstage.io/docs/architecture-decisions/adrs-adr002#format)
 
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  # ...
+  annotations:
+    # This also supports bitbucket/xxx/yyy
+    circleci.com/project-slug: github/my-org/my-repo
+spec:
+  type: service
+  # ...
+```
+
 ## Features
 
 - List top 50 builds for a project