From a010a333a19048a6420c2c69fbb86bf5b5f7c14e Mon Sep 17 00:00:00 2001
From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com>
Date: Sat, 2 Jan 2021 21:19:43 +0100
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 507b89eb..011612f5 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 ![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg)
 
-Generates your metrics that you can embed everywhere !
+Generate your metrics that you can embed everywhere, including your GitHub profile readme !
 
 [![Metrics](https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg)](https://metrics.lecoq.io)
 
@@ -547,7 +547,7 @@ Used template defaults to the `classic` one.
     <td>✔️</td>
   </tr>
   <tr>
-    <th>Repository<sup>MR</sup></th>
+    <th>Repository<sup>R</sup></th>
     <td>✔️</td>
     <td>❌</td>
     <td>❌</td>
@@ -571,6 +571,25 @@ Used template defaults to the `classic` one.
 * **N** : Feature is already released, but new ones are available on `@master`
 * **R** : Repository template (all plugins content will be restricted to related repository)
 
+<details>
+<summary>💬 Using repository template</summary>
+
+To use `repository` template, you'll need to provide a repository name in `query` option.
+
+If repository owner is different from `token` owner, use `user` option to specify it. 
+
+Add the following to your workflow :
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    # ... other options
+    template: repository
+    user: "repository-owner"
+    query: '{"repo":"repository-name"}'
+```
+
+</details>
+
 ## 🧩 Plugins
 
 Plugins are features which can provide additional metrics and features.