Skip to content

Commit 0eec17f

Browse files
committed
docs: Update readme
1 parent 05a4de9 commit 0eec17f

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
<h1 align="center">React ChatBotify Gallery API</h1>
44
</p>
55

6+
<p align="center">
7+
<a href="https://github.com/react-chatbotify/gallery-api/actions/workflows/ci-cd-pipeline.yml"> <img src="https://github.com/react-chatbotify/gallery-api/actions/workflows/ci-cd-pipeline.yml/badge.svg" /> </a>
8+
</p>
9+
610
## Table of Contents
711
* [Introduction](#introduction)
812
* [Features](#features)
@@ -15,13 +19,13 @@
1519

1620
The React ChatBotify Gallery is a new project introduced alongside [**v2 of React ChatBotify**](https://medium.com/@tjtanjin/react-chatbotify-v2-beta-release-whats-changed-what-s-new-and-what-s-next-6aec9e049a98). The purpose of the gallery website is to provide developers with a central place for browsing, rating and sharing both themes and plugins. The website comes with an interactive theme preview feature, which allows developers to try out and visualise how the various themes look like. As an added bonus, the website also comes with a theme builder, which allows developers to directly craft and share themes by uploading them on the website. To support the functionality of the website, a robust backend is required - thus, this API project was created.
1721

18-
Note that this repository contains the code for the backend portion of the gallery project. The frontend code for the gallery project is separately maintained [here](https://github.com/tjtanjin/react-chatbotify-gallery-website).
22+
Note that this repository contains the code for the backend portion of the gallery project. The frontend code for the gallery project is separately maintained [here](https://github.com/react-chatbotify/gallery-website).
1923

2024
### Features
2125

22-
Apart from a handful of background jobs, the Gallery API largely supports requests from the frontend website to perform operations. Thus, the features of the API mirrors/complements those of the [**website**](https://github.com/tjtanjin/react-chatbotify-gallery-website?tab=readme-ov-file#features).
26+
Apart from a handful of background jobs, the Gallery API largely supports requests from the frontend website to perform operations. Thus, the features of the API mirrors/complements those of the [**website**](https://github.com/react-chatbotify/gallery-website?tab=readme-ov-file#features).
2327

24-
For more information on what this project delivers, you may wish to check out the implementation section of the [**Developer Guide**](https://github.com/tjtanjin/react-chatbotify-gallery-api/blob/main/docs/DeveloperGuide.md).
28+
For more information on what this project delivers, you may wish to check out the implementation section of the [**Developer Guide**](https://github.com/react-chatbotify/gallery-api/blob/main/docs/DeveloperGuide.md).
2529

2630
### Technologies
2731
Technologies used by React ChatBotify Gallery API are as below:
@@ -41,19 +45,19 @@ Typescript
4145
</p>
4246

4347
#### Project Repository
44-
- https://github.com/tjtanjin/react-chatbotify-gallery-api
48+
- https://github.com/react-chatbotify/gallery-api
4549

4650
### Team
4751
* [Tan Jin](https://github.com/tjtanjin) (Lead)
4852
* [Hussein Serageldin](https://github.com/HusseinSerag)
4953
* [Hunain Ahmed](https://github.com/hunxjunedo)
5054

5155
### Contributing
52-
If you are looking to contribute to the project, you may find the [**Developer Guide**](https://github.com/tjtanjin/react-chatbotify-gallery-api/blob/main/docs/DeveloperGuide.md) useful.
56+
If you are looking to contribute to the project, you may find the [**Developer Guide**](https://github.com/react-chatbotify/gallery-api/blob/main/docs/DeveloperGuide.md) useful.
5357

54-
In general, the forking workflow is encouraged and you may open a pull request with clear descriptions on the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an [**issue**](https://github.com/tjtanjin/react-chatbotify-gallery-api/issues) or raising it up on [**discord**](https://discord.gg/6R4DK4G5Zh).
58+
In general, the forking workflow is encouraged and you may open a pull request with clear descriptions on the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an [**issue**](https://github.com/react-chatbotify/gallery-api/issues) or raising it up on [**discord**](https://discord.gg/6R4DK4G5Zh).
5559

5660
Note: Templates have been created for pull requests and issues to guide you in the process.
5761

5862
### Support
59-
If there are any questions pertaining to the application itself (usage or implementation wise), you may create an [**issue**](https://github.com/tjtanjin/react-chatbotify-gallery-api/issues), raise it up on [**discord**](https://discord.gg/6R4DK4G5Zh), or drop me an email at: **cjtanjin@gmail.com.**
63+
If there are any questions pertaining to the application itself (usage or implementation wise), you may create an [**issue**](https://github.com/react-chatbotify/gallery-api/issues), raise it up on [**discord**](https://discord.gg/6R4DK4G5Zh), or drop me an email at: **cjtanjin@gmail.com.**

0 commit comments

Comments
 (0)