Skip to content

Commit a1382b5

Browse files
committed
Minor README.md updates
1 parent 1687a6e commit a1382b5

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The generation of usable JSON Web Tokens is available in [web-auth](https://gith
1010

1111
### REST API
1212

13-
- [ ] API for public website
13+
- [ ] API for the public website
1414
- [ ] VOD
1515
- [x] Videos
1616
- [x] Series
@@ -141,7 +141,7 @@ The generation of usable JSON Web Tokens is available in [web-auth](https://gith
141141

142142
### Setting up development database
143143

144-
You will need a PostgreSQL server running locally - either install it on your computer or use Docker.
144+
You will need a PostgreSQL server running locallyeither install it on your computer or use Docker.
145145

146146
Once you've done that, create a database to work with:
147147

@@ -159,11 +159,12 @@ $ go run ./cmd/migrate-db
159159

160160
### Dev side note
161161

162-
If you are trying to connect to a database from your dev machine then I can recommend you use the following command to make your life easier.
162+
If you are trying to connect to a database from your dev machine,
163+
then I can recommend you use the following command to make your life easier.
163164

164165
`ssh -L [local port]:127.0.0.1:[db port on remote server] [remote server user and ip]`
165166

166-
This will prevent the full deploy being your dev environment and is much quicker.
167+
This will prevent the full deployment being your dev environment and is much quicker.
167168

168169
### Static binary
169170

@@ -196,7 +197,8 @@ Build the image.
196197

197198
`docker image build -t web-api .`
198199

199-
You will then need to set the environment variables like how it is set up in `docker-compose.yml` or you might be able to create a container and then use `docker export` so you can run a static binary built in docker.
200+
You will then need to set the environment variables like how it is set up in `docker-compose.yml`
201+
or you might be able to create a container and then use `docker export` so you can run a static binary built-in docker.
200202

201203
#### Docker-compose
202204

@@ -209,7 +211,7 @@ Then fill in the docker-compose file with your credentials.
209211

210212
### Jenkins
211213

212-
Checkout this [document](ci.md).
214+
Check out this [document](ci.md).
213215

214216
## Developing
215217

@@ -244,7 +246,7 @@ Generate docs by running `go generate` in the root of the repo.
244246
- `/services`
245247
Internal API that is the main "business logic" for each service web-api provides.
246248
- `/utils`
247-
Provides access to commonly used functions, i.e. cdn, mq, sql
249+
Provides access to commonly used functions, i.e. CDN, MQ, SQL
248250

249251
### Database info
250252

0 commit comments

Comments
 (0)