diff --git a/README.md b/README.md
index 18d3784..caca8d4 100644
--- a/README.md
+++ b/README.md
@@ -21,29 +21,46 @@ The GitHub Rocket.Chat App provides a seamless integration between GitHub and Ro
Search Issues and Pull Request using extensive filters and share them on Rocket.Chat
-💡 Usage 💡
+💡 Usage 💡
+
+Open Main Modal for Quick Access to Different Features
+
+To open the main modal and access various features, use the command: /github
.
+
+
+### Main Modal Features:
+
+- Quick access to GitHub search
+- Create new issues
+- Manage repository subscriptions
+- Assign issues to users
+
+The app can be accessed with any of the following slash commands: /gh
or /github
.
+
+### Command List
+
- - See Helper Message / Command List -> /github help
- - The app can be accessed with any of the slash commands /gh or /github
- - Login to GitHub -> /github login
- - Logout from GitHub -> /github logout
- - View your GitHub Profile and Issues -> /github me
- - View/Add/Delete/Update Repository Subscriptions -> /github subscribe
- - Subscribe to all repository events -> /github Username/RepositoryName subscribe
- - Unsubscribe to all repository events -> /github Username/RepositoryName unsubscribe
- - Add New Issues to GitHub Repository -> /github issue
- - Search Issues and Pull Request -> /github search
- - Assign and Share GitHub issues -> /github issues
- - Review a Pull Request -> /github Username/RepositoryName pulls pullNumber
- - See Interactive Button interface to fetch repository data -> /github Username/RepositoryName
- - Get details of a Repository -> /github Username/RepositoryName repo
- - Get Issues of a Repository -> /github Username/RepositoryName issues
- - Get Contributors of a Repository -> /github Username/RepositoryName contributors
- - Get Recent Pull Request of a Repository -> /github Username/RepositoryName pulls
+ - See Helper Message / Command List →
/github help
+ - Login to GitHub →
/github login
+ - Logout from GitHub →
/github logout
+ - View your GitHub Profile and Issues →
/github me
+ - View/Add/Delete/Update Repository Subscriptions →
/github subscribe
+ - Subscribe to all repository events →
/github Username/RepositoryName subscribe
+ - Unsubscribe to all repository events →
/github Username/RepositoryName unsubscribe
+ - Add New Issues to GitHub Repository →
/github issue
+ - Search Issues and Pull Request →
/github search
+ - Assign and Share GitHub issues →
/github issues
+ - Review a Pull Request →
/github Username/RepositoryName pulls pullNumber
+ - See Interactive Button interface to fetch repository data →
/github Username/RepositoryName
+ - Get details of a Repository →
/github Username/RepositoryName repo
+ - Get Issues of a Repository →
/github Username/RepositoryName issues
+ - Get Contributors of a Repository →
/github Username/RepositoryName contributors
+ - Get Recent Pull Request of a Repository →
/github Username/RepositoryName pulls
- Add a new repository for pull request review reminders -> /github reminder create
- Get a list of repositories for which you've set up pull request review reminders -> /github reminder list
+
🚀 Contributing 🚀
@@ -56,7 +73,7 @@ The GitHub Rocket.Chat App provides a seamless integration between GitHub and Ro
Set up the Application on your server using our Quick Setup and Application Setup.
Explore the app and look for existing issues to solve. We look forward to new PRs :100:.
If you find a bug or a missing feature, feel free to open a new Issue.
-
If you are new to Rocket.Chat App Development, follow the developement documentation and RocketChat Apps Engine TypeScript Defenitions
+
If you are new to Rocket.Chat App Development, follow the developement documentation and RocketChat Apps Engine TypeScript Defenitions
You can also follow other Rocket.Chat Apps for inspiration : Polls Plus App, ClickUp Rocket.Chat App , Figma Rocket.Chat App
@@ -150,5 +167,4 @@ Once the GitHub OAuth app is setup, open the GitHub Application Settings and ent
The users can login to GitHub by entering the slash command `/github login` and then clicking on the `Login` button.
-Users are logged out after a week but the users can also logout at any time by entering `/github logout`.
-
+Users are logged out after a week but the users can also logout at any time by entering `/github logout`.
\ No newline at end of file