From 3a710f4c1ebbf89df489a05cbaa8847fcda49099 Mon Sep 17 00:00:00 2001
From: Joffrey JAFFEUX <j.jaffeux@gmail.com>
Date: Sat, 7 Dec 2024 17:54:26 +0100
Subject: [PATCH] plugin usage

---
 README.md | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index b0dc1c0..1fec9af 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,12 @@
-# **Plugin Name** Plugin
+# DiscourseRewind
 
-**Plugin Summary**
+Display stats on your last year of Discourse usage.
 
-For more information, please see: **url to meta topic**
+## Usage
+
+- add `http://127.0.0.1:4200/rewinds?` in `SiteSetting.allowed_iframes`
+- example embed of a rewind in a post:
+
+```
+<iframe src="/rewinds?year=2024&username=j.jaffeux" width="400" height="300" frameborder="0" style="border:0;" allowfullscreen="" aria-hidden="false" tabindex="0" />
+```