chore: cleanup API, fix readme

Author: aslushnikov

README.md

@@ -1,6 +1,82 @@
 # PodKeeper
 
-PodKeeper is an open-source library for starting and stopping Docker containers in a way that ensures they won’t linger if the host program crashes or exits unexpectedly without properly stopping them.
+> ⚠️ **Warning:** PodKeeper is currently in pre-1.0.0 release. Expect potential changes and experimental features that may not be fully stable yet.
+
+PodKeeper is a node.js open-source library for starting and stopping Docker containers in a way that ensures they won’t linger if the host program crashes or exits unexpectedly without properly stopping them.
+
+PodKeeper is written in TypeScript and comes bundled with TypeScript types.
+
+- [Getting Started](#getting-started)
+- [Bundled Services & API](#bundled-services--api)
+- [How It Works](#how-it-works)
+- [PodKeeper vs. TestContainers](#podkeeper-vs-testcontainers)
+
+## Getting Started
+
+1. Install podkeeper:
+
+    ```sh
+    npm i --save-dev podkeeper
+    ```
+
+1. Pull container you wish to launch beforehand:
+
+    ```sh
+    docker pull postgres:latest
+    ```
+
+1. Start / stop container programmatically:
+
+    ```ts
+    import { Postgres } from 'podkeeper';
+
+    const postgres = await Postgres.start();
+    // do something with container...
+    await postgres.stop();
+    ```
+
+## Bundled services & API
+
+PodKeeper comes bundled with the following pre-configured services:
+
+* MySQL:
+
+    ```ts
+    import { MySQL } from 'podkeeper';
+    ```
+
+* Postgres
+
+    ```ts
+    import { Postgres } from 'podkeeper';
+    ```
+
+* Minio
+
+    ```ts
+    import { Minio } from 'podkeeper';
+    ```
+
+If a popular service is missing, please do not hesitate to submit a pull request.
+Alternatively, you can launch a generic container service with the `GenericService` class:
+
+```ts
+import { GenericService } from 'podkeeper';
+
+cosnt service = await GenericService.start({
+  imageName: string,
+  ports: number[],
+  healthcheck?: {
+    test: string[],
+    intervalMs: number,
+    retries: number,
+    startPeriodMs: number,
+    timeoutMs: number,
+  },
+  command?: string[],
+  env?: { [key: string]: string | number | boolean | undefined };
+});
+```
 
 ## How It Works
 
@@ -23,4 +99,4 @@ There are also some notable differences in API design philosophy:
 
 - **Process Behavior**: PodKeeper services prevent the Node.js process from exiting, while TestContainers services do not.
 - **Container Pulling**: PodKeeper does not implicitly pull containers, requiring them to be available beforehand, whereas TestContainers lazily pulls containers as needed when launching a service.
-
+- **Healthchecks**: The services that PodKeeper ships out-of-the-box are pre-configured to use proper healthchecks.

src/genericService.ts

@@ -23,7 +23,7 @@ async function connectWebSocket(address: string, deadline: number): Promise<WebS
 }
 
 export class GenericService {
-  static async launch(options: {
+  static async start(options: {
     imageName: string,
     ports: number[],
     healthcheck?: {

src/minio.ts

@@ -2,9 +2,8 @@ import ms from 'ms';
 import { GenericService } from './genericService.js';
 
 export class Minio {
-
-  static async launch({ accessKeyId = 'root', secretAccessKey = 'password' } = {}) {
-    const service = await GenericService.launch({
+  static async start({ accessKeyId = 'root', secretAccessKey = 'password' } = {}) {
+    const service = await GenericService.start({
       imageName: 'quay.io/minio/minio:latest',
       ports: [9000, 9090],
       healthcheck: {

src/mysql.ts

@@ -6,8 +6,8 @@ const MYSQL_PORT = 3306;
 
 export class MySQL {
 
-  static async launch({ db = 'mydatabase', rootPassword = 'rootpassword' } = {}) {
-    const service = await GenericService.launch({
+  static async start({ db = 'mydatabase', rootPassword = 'rootpassword' } = {}) {
+    const service = await GenericService.start({
       imageName: 'mysql:latest',
       ports: [MYSQL_PORT],
       healthcheck: {

src/postgres.ts

@@ -5,8 +5,8 @@ const IMAGE_NAME = 'postgres:latest';
 const POSTGRES_PORT = 5432;
 
 export class Postgres {
-  static async launch({ user = 'user', password = 'password', db = 'postgres' } = {}) {
-    const service = await GenericService.launch({
+  static async start({ user = 'user', password = 'password', db = 'postgres' } = {}) {
+    const service = await GenericService.start({
       imageName: 'postgres:latest',
       ports: [POSTGRES_PORT],
       healthcheck: {