Skip to content

Commit 78bd4bd

Browse files
authored
[*] improve README (#1026)
* Fix typo in README * Improve clarity and fix some more typos.
1 parent 7bc069d commit 78bd4bd

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ docker run --detach --name pw3 \
2323
cybertecpostgresql/pgwatch-demo
2424
```
2525

26-
After some minutes you could open the ["Database Overview"](http://127.0.0.1:3000/d/db-overview/db-overview) dashboard and start looking at metrics. For defining your own dashboards you need to log in Grafana as admin (`admin`/`pgwatchadmin`).
26+
After a few minutes, you can open the ["Database Overview"](http://127.0.0.1:3000/d/db-overview/db-overview) dashboard and start looking at the metrics. To define your own dashboards, you need to log in to Grafana as admin (`admin`/`pgwatchadmin`).
2727

2828
If you don't want to add the test database for monitoring, remove the `PW_TESTDB` parameter when launching the container.
2929

3030
## Development and production use
3131

32-
For production and long term installation `cybertecpostgresql/pgwatch` Docker image should be used.
33-
For the fastest development and deployment experience the Docker compose files are provided.
32+
For production and long-term installation `cybertecpostgresql/pgwatch` Docker image should be used.
33+
For the fastest development and deployment experience, the Docker compose files are provided.
3434

3535
- The usual production setup should involve:
3636

@@ -42,7 +42,7 @@ For the fastest development and deployment experience the Docker compose files a
4242
docker compose -f ./docker/docker-compose.yml up --detach
4343
```
4444

45-
- For development purposes you want to build the image from sources:
45+
- For development purposes, you want to build the image from source:
4646

4747
```shell
4848
git clone https://github.com/cybertec-postgresql/pgwatch.git && cd pgwatch
@@ -69,14 +69,14 @@ These commands will build and start services listed in the compose file:
6969

7070
## Monitor Database
7171

72-
After start, you could open the [monitoring dashboard](http://localhost:3000/) and start
72+
After starting, you could open the [monitoring dashboard](http://localhost:3000/) and start
7373
looking at metrics.
7474

75-
To add a test database under monitoring, you can use [built-in WebUI](http://localhost:8080/).
75+
To add a test database to monitoring, you can use the [built-in WebUI](http://localhost:8080/).
7676

7777
## Produce Workload
7878

79-
To emulate workload for added test database execute:
79+
To emulate workload for the added test database, execute:
8080

8181
```shell
8282
docker/scripts/pgbench.sh
@@ -125,14 +125,14 @@ done in 0.11 s (drop tables 0.11 s).
125125
> [!IMPORTANT]
126126
pgAdmin uses port 80. If you want it to use another port, change it in `docker/compose.pgadmin.yml` file.
127127

128-
To look what is inside `pgwatch` database, you can spin up pgAdmin4:
128+
To look at what is inside the `pgwatch` database, you can spin up pgAdmin4:
129129

130130
```shell
131131
docker compose -f ./docker/docker-compose.yml up --detach pgadmin
132132
```
133133

134-
Go to `localhost` in your favorite browser and login as `admin@local.com`, password `admin`.
135-
Server `pgwatch` should be already added in `Servers` group.
134+
Go to `localhost` in your favorite browser and log in as `admin@local.com`, password `admin`.
135+
Server `pgwatch` should already be added to the `Servers` group.
136136

137137
## Development
138138

@@ -142,11 +142,11 @@ If you apply any changes to the source code and want to restart the agent, it's
142142
docker compose -f ./docker/docker-compose.yml up pgwatch --build --force-recreate --detach
143143
```
144144
145-
The command above will rebuild the `pgwatch` agent from sources and relaunch the container.
145+
The command above will rebuild the `pgwatch` agent from source and relaunch the container.
146146
147147
## Logs
148148
149-
If you are running containers in detached mode, you still can follow the logs:
149+
If you are running containers in detached mode, you can still follow the logs:
150150
151151
```shell
152152
docker compose -f ./docker/docker-compose.yml logs --follow

0 commit comments

Comments
 (0)