diff --git a/README.md b/README.md index cd9c5ab..32016e1 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,18 @@ # Test Containers Test container solution for running third party solutions through docker. + +## Quick Start + +```ts +import { PostgresTestContainer } from "@valkyr/testcontainers/postgres"; + +const container = await PostgresTestContainer.start("postgres:16"); + +await container.create("db"); +await container.client("db")`SELECT 1`; + +console.log(container.url("db")); // => postgres://postgres:postgres@127.0.0.1:5432/db + +await container.stop(); +``` diff --git a/deno.json b/deno.json index 26bc1f7..6f6e345 100644 --- a/deno.json +++ b/deno.json @@ -1,6 +1,6 @@ { "name": "@valkyr/testcontainers", - "version": "1.0.0-rc.1", + "version": "1.0.0", "exports": { "./postgres": "./containers/postgres.ts" },