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

Commit 90b7bac

Browse files
LoisRP0xCLARITYmDuo13
authored
Minor tweaks to PayID readme (#668)
* Minor tweaks to PayID readme * Agree not to use slang. * Updated for clarity as suggested by @mDuo13 and @hbergren Co-authored-by: Hans Bergren <[email protected]> Co-authored-by: Rome Reginelli <[email protected]>
1 parent bfdc4d9 commit 90b7bac

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ _This project is not associated with PayID operated by NPP Australia Ltd. People
1010

1111
This is the reference implementation server for [PayID](https://docs.payid.org/payid-overview), serving the [PayID API](https://api.payid.org/?version=latest). It uses TypeScript, a Node.js HTTP server, and a Postgres database.
1212

13-
By default, the server hosts [the PayID Protocol](https://github.com/payid-org/rfcs), or Public API, on port 8080. It also hosts a second RESTful API on port 8081 for CRUD operations of PayIDs and associated addresses.
13+
By default, the server hosts the Public API, which conforms to the PayID Protocol, on port 8080. The server also hosts a second RESTful API on port 8081 for CRUD (Create/Read/Update/Delete) operations to manage PayIDs and associated addresses.
1414

15-
If you just want to experiment with PayID, you can easily spin up a local server using `npm run devEnvUp` which uses our local [`docker-compose.yml`](./docker-compose.yml) file. If you want to work on the PayID server source code itself, you can spin up a Postgres database to develop against using `npm run devDbUp`.
15+
To experiment with PayID, you can start a local server by running `npm run devEnvUp`, which uses our local [`docker-compose.yml`](./docker-compose.yml) file, which implicitly starts both a database and a PayID server inside Docker containers. To work on the PayID server source code itself, you can start a Postgres database to develop against by running `npm run devDbUp`, which starts a database in a Docker container, and a local PayID server.
1616

17-
To clean up the associated Docker containers, you can run `npm run devDown`.
17+
To clean up the associated Docker containers after you create a local server or database container, run `npm run devDown`.
1818

1919
## Further Reading
2020

0 commit comments

Comments
 (0)