merge pull request #73 from DeskproApps/chore/SC-159738-improve-readme-appearance

SC-159738 chore: improve ReadMe appearance

Author: tidbit1

README.md

@@ -1,9 +1,97 @@
-<img align="right" alt="Deskpro" src="https://raw.githubusercontent.com/DeskproApps/github/master/docs/assets/deskpro-logo.svg" />
+<div align='center'>
+  <a target='_blank' href=''><img src='https://img.shields.io/github/contributors/deskproapps/github.svg?style=for-the-badge' alt='Contributors' /></a>
+  <a target='_blank' href='https://github.com/deskproapps/github/issues'><img src='https://img.shields.io/github/issues/deskproapps/github.svg?style=for-the-badge' alt='Issues' /></a>
+  <a target='_blank' href='https://github.com/deskproapps/github/blob/master/LICENSE.md'><img src='https://img.shields.io/github/license/deskproapps/github.svg?style=for-the-badge' alt='MIT License' /></a>
+  <a target='_blank' href='https://github.com/deskproapps/github/releases'><img src='https://img.shields.io/github/v/release/deskproapps/github?style=for-the-badge' alt='GitHub Release' /></a>
+  <a target='_blank' href='https://www.linkedin.com/company/deskpro'><img src='https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555' alt='LinkedIn' /></a>
+  <img src='readme.svg' />
+</div>
 
-# Github App
+<div align='center'>
+  <h1>GitHub App</h1>
+  <p>Our GitHub integration will help you track issues linked to tickets in real-time.</p>
+  <a href='https://support.deskpro.com/ga/guides/developers/anatomy-of-an-app' target='_blank'>Deskpro Apps Documentation</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href='https://docs.github.com/en/rest' target='_blank'>GitHub API Documentation</a>
+  <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+  <a href='./SETUP.md' target='_blank'>GitHub App Setup Guide</a>
+  <br />
+  <hr />
+  <br />
+</div>
 
-View your GitHub issues from Deskpro and link them to tickets you are working on
+![screenshot of the GitHub App](./docs/readme/app-screenshot.png)
 
-![Github App - Deskpro](https://raw.githubusercontent.com/DeskproApps/github/master/docs/assets/github_screenshot_01.png)
+## **About the App**
+The GitHub App enhances your Deskpro experience by integrating GitHub's powerful issue tracking and repository management features directly into your helpdesk. With this app, agents can link tickets to GitHub issues, track their progress in real-time, and streamline collaboration between support and development teams.
 
-[Find out more about our Github App](https://www.deskpro.com/apps/github)
+## **Setting up the app in Deskpro**
+You can follow our [setup guide](./SETUP.md) for a step-by-step guide to setting up the GitHub app in Deskpro.
+
+## Development
+
+### With DevContainers (Recommended)
+To make development easier and avoid version conflicts, we recommend using **DevContainers** for local development. This approach ensures that everyone on the team uses the same environment, reducing setup issues and version mismatches between dependencies.
+
+#### Why use DevContainers?
+- **Consistency:** All developers work in the same environment, with the same versions of dependencies, tools, and configurations.
+- **Speed:** The DevContainer setup is quick to start, letting you focus on coding rather than environment setup.
+- **Isolation:** Avoid conflicts between different versions of Node.js, PNPM, or other dependencies by using the predefined container setup.
+
+#### Getting Started with DevContainers
+1. Ensure that you have [Docker](https://www.docker.com/get-started) and [VS Code](https://code.visualstudio.com/) installed.
+2. Open the project in [VS Code](https://code.visualstudio.com/).
+3. If you have the **Remote - Containers** extension installed, [VS Code](https://code.visualstudio.com/) should automatically detect the `.devcontainer` configuration in this project and prompt you to reopen the folder in the container.
+4. After opening the project in the DevContainer, run:
+   ```bash
+   pnpm start
+   ```
+
+You should now be able to view the app in your browser. For more information about developing [Deskpro apps](https://www.deskpro.com/apps), [Visit the docs](https://support.deskpro.com/ga/guides/developers/anatomy-of-an-app).
+
+### Natively
+_We recommend using the DevContainer mentioned above for Consistency, Speed and Isolation._
+
+This app was developed primarily using **TypeScript**, **React**, and **Vite**.
+
+#### Setup
+To run this project locally:
+
+ ```bash
+# Clone the repository
+git clone https://github.com/DeskproApps/github.git
+
+# Change to the project directory
+cd github
+
+# Install dependencies
+pnpm install
+
+# Run the development server
+pnpm start
+```
+
+You should now be able to view the app in your browser. For more information about developing [Deskpro Apps](https://www.deskpro.com/apps), [Visit the Docs](https://support.deskpro.com/ga/guides/developers/anatomy-of-an-app).
+
+### Testing
+We've included `jest` to run tests. It will look anywhere in `/src` for test suite files ending in `.test.tsx` or `.test.ts`.
+
+You can run all tests using:
+
+```bash
+pnpm test
+```
+
+## Versioning
+Every app deployment requires that the version property in the `manifest.json` file be updated to reflect the new app version. This is so Deskpro can detect changes and add/upgrade apps accordingly. As such, we've made altering versions easy by having CI make the actual version change for you. Here's what we do:
+
+* We increment **patch** versions, i.e. 1.0.1, automatically. This is the default
+* **Minor** versions, i.e. 1.1.0, are incremented if you add the `minor-version` GitHub label to your PR
+* **Major** versions, i.e. 2.0.0, are incremented if you add the `major-version` GitHub label to your PR
+
+## Top Contributors
+[![Contributors](https://contrib.rocks/image?repo=deskproapps/github)](https://github.com/deskproapps/github/graphs/contributors)
+
+
+## License
+Distributed under the MIT License. See [LICENSE.md](LICENSE.md) for more information.