export some types that might be useful from index

README.md

@@ -1,8 +1,40 @@
 # docker-client-ts
 
-installation
+## installation
 ```shell
 npm add docker-client-ts
 ```
 
-see [tests](tests) for example usage
+## usage
+```typescript
+import { DockerClient } from "docker-client-ts";
+
+const docker = await DockerClient({
+  baseURL: new URL("unix:/var/run/docker.sock"),
+  ssh: {
+    user: "username",
+    host: "127.0.0.1",
+    port: 22,
+    key: Buffer.from("ssh private key", "utf8"),
+  },
+});
+
+const { Id } = await client.Container.Create({
+  body: {
+    Image: "debian",
+    Cmd: ["bash"],
+    Tty: true,
+  },
+});
+
+await client.Container.Start({
+  path: { id: Id },
+});
+```
+
+see [tests](tests) for more example usage
+
+<sub>
+Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States
+and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.
+</sub>

static/etc.ts

@@ -97,7 +97,10 @@ export function terminal(resp: Dispatcher.UpgradeData): TerminalSession {
   };
 
   resp.socket.on("data", (chunk: Buffer) => {
-    output.next(chunk.subarray(8).toString("binary"));
+    const out = chunk.subarray(8).toString("binary");
+    for (const line of out.trim().split("\n")) {
+      output.next(line);
+    }
   });
 
   setTimeout(async () => {

templates/root.tmpl

@@ -8,6 +8,9 @@ import {{ tag }} from "~/tags/{{ tag | lower }}"
 {% endfor %}
 
 export { ComposeSpecificationSchema } from "~/compose";
+export { type DockerClientParams } from "~/etc"
+
+export type DockerClientType = Awaited<ReturnType<typeof DockerClient>>;
 
 export async function DockerClient(params: DockerClientParams) {
   const { pool, close } = await getPool(params);