Skip to content

Commit 3c34db4

Browse files
authored
Update README.md
1 parent c2feddb commit 3c34db4

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
1-
## Mirror
1+
<h1 align="center">API Mirror</h1>
22

33
![Mirror](https://socialify.git.ci/GameHub88/Mirror/image?description=1&descriptionEditable=A%20simple%20proxy%20server%20for%20the%20GameHub%20API&font=Inter&forks=1&issues=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2FGameHub88%2FGameHub%2Fmain%2Fassets%2Fimg%2Flogo.png&name=1&owner=1&pattern=Floating%20Cogs&pulls=1&stargazers=1&theme=Dark)
44

5-
## Deploy it yourself
5+
<h1 align="center">Deploy it yourself</h1>
6+
<p align="center">
7+
<a href="https://app.cyclic.sh/api/app/deploy/GameHub88/Mirror"><img src="https://binbashbanana.github.io/deploy-buttons/buttons/remade/cyclic.svg" /></a>
8+
<a href="https://heroku.com/deploy/?template=https://github.com/GameHub88/Mirror"><img src="https://binbashbanana.github.io/deploy-buttons/buttons/remade/heroku.svg" /></a>
9+
<a href="https://render.com/deploy?repo=https://github.com/GameHub88/Mirror"><img src="https://binbashbanana.github.io/deploy-buttons/buttons/remade/render.svg"/></a>
10+
<a href="https://replit.com/github/GameHub88/Mirror"><img src="https://binbashbanana.github.io/deploy-buttons/buttons/remade/replit.svg" /></a>
11+
</p>
612

7-
[![Deploy to Cyclic](https://binbashbanana.github.io/deploy-buttons/buttons/remade/cyclic.svg)](https://app.cyclic.sh/api/app/deploy/GameHub88/Mirror)
8-
[![Deploy to Heroku](https://binbashbanana.github.io/deploy-buttons/buttons/remade/heroku.svg)](https://heroku.com/deploy/?template=https://github.com/GameHub88/Mirror)
9-
[![Deploy to Render](https://binbashbanana.github.io/deploy-buttons/buttons/remade/render.svg)](https://render.com/deploy?repo=https://github.com/GameHub88/Mirror)
10-
[![Run on Replit](https://binbashbanana.github.io/deploy-buttons/buttons/remade/replit.svg)](https://replit.com/github/GameHub88/Mirror)
11-
12-
## Localy
13+
<h1 align="center">Localy</h1>
1314
If you want to run and test the server localy on your device, navigate to your console and run:
15+
<br><br>
1416

1517
```bash
1618
git clone https://github.com/GameHub88/Mirror.git
1719
```
20+
1821
Make sure you have [nodejs](https://nodejs.org) installed for these next steps:
1922
```bash
2023
cd Mirror
@@ -27,14 +30,15 @@ npm start
2730
```
2831
then navigate on your web browser to [`localhost:2000`](http://localhost:2000) or [`127.0.0.1:2000`](http://127.0.0.1:2000) to test the server.
2932

30-
## API Docs
33+
<h1 align="center">Docs</h1>
3134

3235
| Path | Data | Parameters | Method |
3336
|------|------|------------|--------|
3437
| / |`{status: 'ready'/'inoperable', version: version, website: website, description: 'A simple proxy server for the GameHub API',repository: 'https://github.com/GameHub88/Mirror'}` | none | GET |
3538
| /games | `[{thumbnail: game-thumbnail, name: game-name, id: game-id}]`| none | GET |
3639
| /games/:game-id | `{name: game-name,url: game-url,thumbnail: game-thumbnail}` | hostname | GET |
3740

38-
## Contributors
39-
40-
![Contrib](https://contrib.rocks/image?repo=GameHub88/Mirror)
41+
<h1 align="center">Contributors</h1>
42+
<p align="center">
43+
<img src="https://contrib.rocks/image?repo=GameHub88/Mirror"/>
44+
</p>

0 commit comments

Comments
 (0)