Skip to content

Commit

Permalink
docs: update README.md and add image/logo
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrohenrikle committed Mar 8, 2024
1 parent 97f1482 commit a5982ca
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
Binary file added .github/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
<style>
table {
width: 100%;
border-collapse: collapse;
}
th, td {
border: 1px solid black;
padding: 8px;
text-align: left;
}
</style>

<div align="center">

<img width="150px" src="./.github/images/logo.png"/>
Expand Down Expand Up @@ -147,9 +135,13 @@ Here you can see all the endpoints of the application
<br><br>

- ```PATCH - '/token/refresh'```
- This the route where, if you have a refresh token, we will generate another JWT Token.
- This route will check if the user has an access token. If not, it will try to create another one based on the refresh token located in cookies. You must send the requisition with the access token as authorization (if you have one).
<br><br>

| Header | Type |
| :--- | :--- |
| `Authorization` | **Bearer** |

<br><br>

- ```GET - '/me'```
Expand Down Expand Up @@ -254,7 +246,7 @@ On ***Check Ins***, every route needs to be authenticated.
<br><br>

- ```POST - '/gyms/:gymId/check-ins'```
- Here we can create a check-in on a gym. You must provide on the URL param the id of the gym as **gymID** and on the body of the request the **latitude** and **longitude** of the user as a JSON
- Here we can create a check-in on a gym. You must provide on the URL param the id of the gym as **gymID** and on the body of the request the **latitude** and **longitude** of the user as a JSON.

| Params | Type | Default |
| :--- | :--- | :--- |
Expand Down

0 comments on commit a5982ca

Please sign in to comment.