Skip to content
This repository was archived by the owner on Jun 10, 2024. It is now read-only.

Commit 6b05e8e

Browse files
fix: grammar, typos & organized socials (#315)
1 parent fcf78ef commit 6b05e8e

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ An API to manage our #EddieHub community data.
1414
## Rules
1515

1616
- Commits follow the standard [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)
17-
- Branches should be named as `issue-<issue no>` (e.g. [NestJs](https://github.com/EddieHubCommunity/api/issues/12) issue number is 12)
17+
- Branches should be named as `issue-<issue no>` (e.g. [NestJS](https://github.com/EddieHubCommunity/api/issues/12) issue number is 12)
1818

1919
## Requirements
2020

@@ -26,11 +26,11 @@ An API to manage our #EddieHub community data.
2626

2727
### Gitpod
2828

29-
Gitpod is a Service, which provides development environments in the cloud. In case no plan is purchased the reguar `Opensource License` allows to use the service for 50 hours per month for free.
29+
Gitpod is a Service, which provides development environments in the cloud. In case no plan is purchased the regular `Opensource License` allows to use the service for 50 hours per month for free.
3030

3131
All that needs to be done, is logging in to their service with a valid GitHub account.
3232

33-
1. [OPTIONAL] Install the Browser Extension from Gitpod.<br>- [Chrome](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki)<br>- [Firefox](https://addons.mozilla.org/de/firefox/addon/gitpod/)
33+
1. Install the Browser Extension from Gitpod. [**OPTIONAL**]<br>- [Chrome](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki)<br>- [Firefox](https://addons.mozilla.org/de/firefox/addon/gitpod/)
3434
2. Just hit the Gitpod button in the `README` file. Everything will spin up automatically.
3535
3. When you're finished with your contribution just close the workspace.
3636

@@ -63,7 +63,7 @@ $ npm run start:prod
6363

6464
- The API-Token is a static token, which gets set in the environment-variables as `APPROVED_TOKENS`.
6565
- This token is used to authenticate an 'admin-App' against the API. The API-Token is used to generate **Bearer-Tokens**.
66-
- For generating more than one token they can be passed to the environment-variables as a comma-seperated list.
66+
- For generating more than one token they can be passed to the environment-variables as a comma-separated list.
6767

6868
## Swagger docs
6969

@@ -88,7 +88,7 @@ $ npm run test:cov
8888
## Logging
8989

9090
Logging can be turned on by settings an environment-variable `DEBUG=true`.
91-
If this variables is not true or undefined no Logs will be made.
91+
If this variable is not true or undefined no Logs will be made.
9292

9393
When set to `true` the App will Log every incoming request.
9494

@@ -119,7 +119,7 @@ To use Authentication the token needs to be passed in the `token`-header of the
119119

120120
## Socials
121121

122-
Join our Discord community [here](http://discord.eddiehub.org/)
123-
Subscribe our YouTube channel [here](https://www.youtube.com/user/eddiejaoude)
122+
- Join our Discord community [here](http://discord.eddiehub.org/)
123+
- Subscribe to our YouTube channel [here](https://www.youtube.com/user/eddiejaoude)
124124

125125
## MADE WITH :heart: BY EDDIEHUBBERS :sparkles::sparkles:

0 commit comments

Comments
 (0)