feat: update readme

This commit is contained in:
2025-04-17 17:36:24 +00:00
parent ff1d59ca8c
commit 26b3e852ef
2 changed files with 20 additions and 0 deletions

View File

@@ -8,6 +8,10 @@ Test container solution for running third party solutions through docker.
## Quick Start
We have quick start support for `postgres` and `mongodb`.
### Postgres
```ts
import { PostgresTestContainer } from "@valkyr/testcontainers/postgres";
@@ -20,3 +24,16 @@ console.log(container.url("db")); // => postgres://postgres:postgres@127.0.0.1:5
await container.stop();
```
### MongoDB
```ts
import { MongoTestContainer } from "@valkyr/testcontainers/mongodb";
const container = await MongoTestContainer.start();
console.log(container.url()); // mongodb://user:pass@127.0.0.1:27017
console.log(await container.client.db("admin").command({ ping: 1 })) // { ok: 1 }
await container.stop();
```