From 3cf71bd666a96ef799bdf729f41fc3c020160c2c Mon Sep 17 00:00:00 2001
From: Abhay-soni-developer <abhaysoni.developer@gmail.com>
Date: Mon, 6 Feb 2023 12:29:19 +0530
Subject: [PATCH] readme modified

Signed-off-by: Abhay-soni-developer <abhaysoni.developer@gmail.com>
---
 plugins/microsoft-calendar/README.md | 48 ++++++++++++++++++++++------
 1 file changed, 39 insertions(+), 9 deletions(-)

diff --git a/plugins/microsoft-calendar/README.md b/plugins/microsoft-calendar/README.md
index 71e547cf9e..76a879b098 100644
--- a/plugins/microsoft-calendar/README.md
+++ b/plugins/microsoft-calendar/README.md
@@ -1,18 +1,48 @@
-# microsoft-calendar
-
-Welcome to the microsoft-calendar plugin!
+# Microsoft-Calendar Plugin
 
+Welcome to the Microsoft calendar plugin!
 _This plugin was created through the Backstage CLI_
 
-You can use this plugin by import MicrosoftCalendar from "@backstage/plugin-microsoft-calendar"
+## Features
 
-> import { MicrosoftCalendar } from "@backstage/plugin-microsoft-calendar"
+1. You can switch between calendars, using the select menu on the calendar card header.
+2. Card showing the list of events on the selected date and the selected calendar (provided by Outlook calendar).
+3. Link to join the online meeting on the event card if provided. so you can join your meetings right away hassle-free.
+4. Hovering over the event will pop over a card showing the event summary message, and list of attendees.
+5. attendee's chips will have a badge over them symbolizing their responses.
+   - green --> accepted
+   - red --> declined
+   - nothing --> not responded yet
 
->        <Grid item xs={12} md={4}>
->          <MicrosoftCalendar />
->        </Grid>
+## Setup
 
-![MicrosoftCalendar plugin screenshot](./docs/microsoft-calendar-plugin.png)
+The following sections will help you set up the Microsoft calendar plugin.
+
+### Microsoft azure authentication provider
+
+> You need to setup [microsoft azure authentication provider](https://backstage.io/docs/auth/microsoft/provider), before you move forward with any of the below step if you have'nt already.
+
+1. Install the plugin by running this command
+
+```bash
+# From the Backstage repository root
+yarn add --cwd packages/app @backstage/plugin-microsoft-calendar
+```
+
+You need to first import the Microsoft calendar React component from "@backstage/plugin-microsoft-calendar".
+You can then use the provided component Microsoft calendar in the backstage frontend where ever you want
+
+```tsx
+import { MicrosoftCalendar } from '@backstage/plugin-microsoft-calendar';
+
+// ...
+<Grid item xs={12} md={4}>
+  <MicrosoftCalendar />
+</Grid>;
+// ...
+```
+
+![Microsoft Calendar plugin demo](https://user-images.githubusercontent.com/23618736/215717491-25db5fa6-b237-487f-8c00-28f572e8da05.mp4)
 
 You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
 This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.