Skip to content

Commit d782ea2

Browse files
committed
Update README with documentation section
1 parent 88c303e commit d782ea2

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ npm install pgmock
1515
If you'd like to run `pgmock` in a browser, see the [Browser support](#browser-support) section for detailed instructions.
1616

1717
## Getting started
18-
After `npm install pgmock`, you can run an in-memory server like so:
18+
You can run an in-memory server like so:
1919

2020
```typescript
2121
import { PostgresMock } from "pgmock";
@@ -42,6 +42,10 @@ It is considered good practice to destroy the mock server after you are done wit
4242
mock.destroy();
4343
```
4444

45+
## Documentation
46+
47+
Check the [PostgresMock source file](https://github.com/stackframe-projects/pgmock/blob/main/src/postgres-mock.ts) for a list of all available methods and their documentation.
48+
4549
## Browser support
4650

4751
`pgmock` fully supports browser environments. While webapps can't listen to TCP ports, you can still use `PostgresMock.createSocket` and the `node-postgres` configuration. However, if your bundler statically analyzes imports, the default configuration may show a warning because of missing (optional) Node.js modules. Check `examples/web-demo/next.config.mjs` for an example on how to configure Webpack for bundling.

0 commit comments

Comments
 (0)