Skip to content

Commit 5a5c4ae

Browse files
authored
fix: grammar
1 parent 1ea2ada commit 5a5c4ae

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

api/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![Unit Tests](https://github.com/USTakAssociation/playtak-api/actions/workflows/ci.yml/badge.svg)
66

7-
The Play Tak API is a nodejs built using the nestjs project which contains multiple endpoints for servicing data to the Play Tak UI
7+
The Play Tak API is a nodejs built using the nestjs project which contains multiple endpoints for servicing data to the Play Tak UI.
88

99
## Requirements
1010

@@ -19,14 +19,14 @@ $ npm install
1919

2020
## Running the app
2121

22-
There are 2 options to run the project either manually or with docker (*recommended)
22+
There are two options to run the project: manually, or with docker (recommended).
2323

24-
Either option you go you will need to create 2 databases which can be done with the following bash script
24+
Either way, you will need to create two databases, which can be done with the following bash script:
2525

2626
```bash
2727
sh ../script/development/create_databases.sh
2828
```
29-
This creates the players and games sqlite dbs
29+
This creates the players and games sqlite databases.
3030

3131
Optionally, you can then use the script `scripts/development/add_user.sh` to add users to the local players database with a password of "password".
3232

@@ -37,7 +37,7 @@ Optionally, you can then use the script `scripts/development/add_user.sh` to add
3737

3838
### docker
3939

40-
In the root of the repo run the following command
40+
In the root of the repo, run the following command:
4141
```bash
4242
docker compose up -d --build
4343
```

0 commit comments

Comments
 (0)