Skip to content

Commit

Permalink
Update README.md to add contributor stats widget
Browse files Browse the repository at this point in the history
  • Loading branch information
samad-yar-khan authored Mar 23, 2023
1 parent d9b2e2e commit 6c9f920
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

The GitHub Rocket.Chat App provides a seamless integration between GitHub and Rocket.Chat and improves collaboration between developers. The application allows users to search and share Issues and Pull Request, Subscribe to Repository Events, create New Issues, Review and Merge Pull Requests and do much more right from Rocket.Chat.


<h2 align='center'>🚀 Features 🚀</h2>
<ul>
<li>Quick and Easy Setup</li>
Expand Down Expand Up @@ -41,8 +42,25 @@ The GitHub Rocket.Chat App provides a seamless integration between GitHub and Ro
<li> Get Recent Pull Request of a Repository -> /github Username/RepositoryName pulls </li>
</ul>

<h2 align='center'>🚀 Contributing 🚀</h2>

<div align='center' width='100%'>
<a href="https://www.middlewarehq.com/">
<img src="https://open-source-assets.middlewarehq.com/svgs/RocketChat-Apps.Github22-contributor-metrics-dark-widget.svg?metrics=true"></img>
</a>
</div>

<ul>
<li>Set up the Application on your server using our <a href="#desktop_computer-quick-setup-desktop_computer">Quick Setup</a> and <a href="#desktop_computer-application-setup-desktop_computer">Application Setup</a>.</li>
<li>Explore the app and look for existing issues to solve. We look forward to new PRs :100:.</li>
<li>If you find a bug or a missing feature, feel free to open a new Issue.</li>
<li>If you are new to Rocket.Chat App Development, follow the <a href="https://developer.rocket.chat/apps-engine/rocket.chat-app">developement documentation</a> and <a href="https://rocketchat.github.io/Rocket.Chat.Apps-engine/">RocketChat Apps Engine TypeScript Defenitions</a></li>
<li>You can also follow other Rocket.Chat Apps for inspiration : <a href="https://github.com/Poll-Plus/rocket.chat.app-poll">Polls Plus App</a>, <a href="https://github.com/RocketChat/Apps.ClickUp">ClickUp Rocket.Chat App</a> , <a href="https://github.com/RocketChat/Apps.Figma">Figma Rocket.Chat App</a>
</ul>


<h2 align='center'>🖥️ Quick Setup 🖥️</h2>

<h2 align='center' id="quick-setup">:desktop_computer: Quick Setup :desktop_computer:</h2>

<h2 align='center'> Gitpod 🍊 </h2>

Expand All @@ -62,7 +80,7 @@ Using [Thrust](https://github.com/henit-chobisa/Thrust.RC) for quickly setup you
npm install -g @rocket.chat/apps-cli
```

Check of the CLI has been installed
Check if the CLI has been installed

```
rc-apps -v
Expand Down Expand Up @@ -105,7 +123,7 @@ Using [Thrust](https://github.com/henit-chobisa/Thrust.RC) for quickly setup you
The Application is now installed on the server. You can verify this by checking the installed applications from the administration panel.
Enter `/github` or `/github help` in the message input box of any channel on the server to know about different features and how to trigger them using different slash commands.

<h2 align='center'>🖥️ Application Setup 🖥️</h2>
<h2 align='center'>:desktop_computer: Application Setup :desktop_computer:</h2>

<p>The GitHub App uses the GitHub OAth2 and you must setup a GitHub OAuth App to unlock the full potential of the GitHub App.</p>

Expand All @@ -132,12 +150,3 @@ The users can login to GitHub by entering the slash command `/github login` and

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

<h2 align='center'>🚀 Contrubuting 🚀</h2>

<ul>
<li>After Setting up the Application on your server, look for open issues.</li>
<li>If you are new to Rocket.Chat App Development, follow the <a href="https://developer.rocket.chat/apps-engine/rocket.chat-app">developement documentation</a> and <a href="https://rocketchat.github.io/Rocket.Chat.Apps-engine/">RocketChat Apps Engine TypeScript Defenitions</a></li>
<li>You can also follow other Rocket.Chat Apps for inspiration : <a href="https://github.com/Poll-Plus/rocket.chat.app-poll">Polls Plus App</a>, <a href="https://github.com/RocketChat/Apps.ClickUp">ClickUp Rocket.Chat App</a> , <a href="https://github.com/RocketChat/Apps.Figma">Figma Rocket.Chat App</a>
</ul>


0 comments on commit 6c9f920

Please sign in to comment.