@hallmaster/docker.js 0.0.6 → 0.0.8

package/README.md

@@ -0,0 +1,60 @@
+# Docker.js
+
+This repository is heavily used for the Hallmaster project, that you can check
+out [right here](https://github.com/hallmasterorg/hallmaster).
+
+It is a library used to manipulate Docker containers, images and all interfaces
+that can be managed by the Docker Engine.
+
+## How to use
+
+The entrypoint of this library is the `DockerSocket` object. It has to be
+instantiated given a UNIX socket (the one used by the Docker Engine) as well as
+the API hostname.
+
+```typescript
+// index.ts
+import { DockerSocket } from "@hallmaster/docker.js";
+
+(async function () {
+  const socket = new DockerSocket();
+
+  await socket.init(); // prepare the UNIX socket to be used
+
+  // if you want, you may authenticate to a Docker Image registry
+  // await socket.authenticate(
+  //   "ghcr.io",
+  //   "github_username",
+  //   "github_pat",
+  // );
+  // console.log(socket.token);
+
+  // you can get the information of the API from the socket such as the version
+  // of the Docker Engine
+  console.log(await socket.info());
+})();
+```
+
+Once you have instantiated the `DockerSocket` object and initialized it with the
+`init()` method, you are ready to use it everywhere.
+
+For instance, to fetch data from containers, you may use this snippet :
+
+```typescript
+import { DockerContainer } from "@hallmaster/docker.js";
+
+(async function() {
+    // ...
+
+    const containerApi = new DockerContainer(dockerSocket);
+
+    const containers = await containerApi.list();
+    for (const container of containers) {
+        const containerLogs = await containerApi.logs(container.Id);
+        console.log("-----------");
+        console.log(`Logs for the container #${container.Id}`);
+        console.log(containerLogs);
+        console.log("-----------");
+    }
+})();
+```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hallmaster/docker.js",
   "description": "A TypeScript Docker API wrapper mainly used for the Hallmaster project.",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "private": false,
@@ -15,10 +15,15 @@
     "dist"
   ],
   "repository": "github:hallmasterorg/hallmaster-docker-wrapper",
+  "homepage": "https://github.com/hallmasterorg/hallmaster-docker-wrapper#readme",
   "devDependencies": {
     "@types/node": "^25.0.9",
     "typescript": "^5.9.3"
   },
+  "keywords": [
+    "docker",
+    "hallmaster"
+  ],
   "scripts": {
     "clean": "rm -rf dist",
     "build": "tsc"