Skip to content

Commit 48620bb

Browse files
committed
docs(Main-modal): 📝 add docs for main modal
1 parent 6856bf5 commit 48620bb

File tree

1 file changed

+36
-21
lines changed

1 file changed

+36
-21
lines changed

README.md

Lines changed: 36 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,44 @@ The GitHub Rocket.Chat App provides a seamless integration between GitHub and Ro
2121
<li>Search Issues and Pull Request using extensive filters and share them on Rocket.Chat</li>
2222
</ul>
2323

24-
<h2 align='center'>💡 Usage 💡</h2>
24+
<h2 align="center">💡 Usage 💡</h2>
25+
26+
<p style="font-size: 1em;"><em>Open Main Modal for Quick Access to Different Features</em></p>
27+
28+
<p>To open the main modal and access various features, use the command: <code>/github</code>.</p>
29+
30+
31+
### Main Modal Features:
32+
33+
- Quick access to GitHub search
34+
- Create new issues
35+
- Manage repository subscriptions
36+
- Assign issues to users
37+
38+
<p style="font-size: 1rem" >The app can be accessed with any of the following slash commands: <code>/gh</code> or <code>/github</code>.</p>
39+
40+
### Command List
41+
2542
<ul>
26-
<li> See Helper Message / Command List -> /github help </li>
27-
<li> The app can be accessed with any of the slash commands /gh or /github </li>
28-
<li> Open Main Modal for quick access to different features -> /github </li>
29-
<li> Login to GitHub -> /github login </li>
30-
<li> Logout from GitHub -> /github logout </li>
31-
<li> View your GitHub Profile and Issues -> /github me </li>
32-
<li> View/Add/Delete/Update Repository Subscriptions -> /github subscribe </li>
33-
<li> Subscribe to all repository events -> /github Username/RepositoryName subscribe </li>
34-
<li> Unsubscribe to all repository events -> /github Username/RepositoryName unsubscribe </li>
35-
<li> Add New Issues to GitHub Repository -> /github issue </li>
36-
<li> Search Issues and Pull Request -> /github search </li>
37-
<li> Assign and Share GitHub issues -> /github issues </li>
38-
<li> Review a Pull Request -> /github Username/RepositoryName pulls pullNumber </li>
39-
<li> See Interactive Button interface to fetch repository data -> /github Username/RepositoryName </li>
40-
<li> Get details of a Repository -> /github Username/RepositoryName repo </li>
41-
<li> Get Issues of a Repository -> /github Username/RepositoryName issues </li>
42-
<li> Get Contributors of a Repository -> /github Username/RepositoryName contributors </li>
43-
<li> Get Recent Pull Request of a Repository -> /github Username/RepositoryName pulls </li>
43+
<li><strong>See Helper Message / Command List →</strong> <code>/github help</code></li>
44+
<li><strong>Login to GitHub →</strong> <code>/github login</code></li>
45+
<li><strong>Logout from GitHub →</strong> <code>/github logout</code></li>
46+
<li><strong>View your GitHub Profile and Issues →</strong> <code>/github me</code></li>
47+
<li><strong>View/Add/Delete/Update Repository Subscriptions →</strong> <code>/github subscribe</code></li>
48+
<li><strong>Subscribe to all repository events →</strong> <code>/github Username/RepositoryName subscribe</code></li>
49+
<li><strong>Unsubscribe to all repository events →</strong> <code>/github Username/RepositoryName unsubscribe</code></li>
50+
<li><strong>Add New Issues to GitHub Repository →</strong> <code>/github issue</code></li>
51+
<li><strong>Search Issues and Pull Request →</strong> <code>/github search</code></li>
52+
<li><strong>Assign and Share GitHub issues →</strong> <code>/github issues</code></li>
53+
<li><strong>Review a Pull Request →</strong> <code>/github Username/RepositoryName pulls pullNumber</code></li>
54+
<li><strong>See Interactive Button interface to fetch repository data →</strong> <code>/github Username/RepositoryName</code></li>
55+
<li><strong>Get details of a Repository →</strong> <code>/github Username/RepositoryName repo</code></li>
56+
<li><strong>Get Issues of a Repository →</strong> <code>/github Username/RepositoryName issues</code></li>
57+
<li><strong>Get Contributors of a Repository →</strong> <code>/github Username/RepositoryName contributors</code></li>
58+
<li><strong>Get Recent Pull Request of a Repository →</strong> <code>/github Username/RepositoryName pulls</code></li>
4459
</ul>
4560

61+
4662
<h2 align='center'>🚀 Contributing 🚀</h2>
4763

4864
<div align='center' width='100%'>
@@ -149,5 +165,4 @@ Once the GitHub OAuth app is setup, open the GitHub Application Settings and ent
149165

150166
The users can login to GitHub by entering the slash command `/github login` and then clicking on the `Login` button.
151167

152-
Users are logged out after a week but the users can also logout at any time by entering `/github logout`.
153-
168+
Users are logged out after a week but the users can also logout at any time by entering `/github logout`.

0 commit comments

Comments
 (0)