docs: add README.md

Author: aslushnikov

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Degu Labs, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,20 @@
+# 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.
+
+## How It Works
+
+Each Docker container has a primary process, known as the "entrypoint," which keeps the container running. For example, when you start a PostgreSQL container, it runs the `postgres` binary. When this binary exits, the container stops as well.
+
+PodKeeper wraps the entrypoint in a special binary called `deadmanswitch`, which not only starts the entrypoint but also launches a WebSocket server. The client that initiated the container must connect to this WebSocket server; otherwise, the container will self-terminate after 10 seconds.
+
+This setup creates a connection between the launched container and its owner. Whenever this WebSocket disconnects, the `deadmanswitch` program automatically stops the container.
+
+## PodKeeper vs. TestContainers
+
+Both PodKeeper and [TestContainers](https://testcontainers.com/) address the problem of starting, stopping, and cleaning up Docker containers:
+
+- **TestContainers** uses a dedicated Docker container called "Ryuk" to handle cleanup.
+- **PodKeeper** manages cleanup using a [dead man's switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch) mechanism.
+
+While TestContainers is a well-established solution with a solid industry record, PodKeeper is an experimental approach exploring an alternative cleanup method.

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "deadmanswitch",
+  "name": "podkeeper",
   "type": "module",
   "version": "0.2.5",
   "description": "",
@@ -14,9 +14,14 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/flakiness/podkeeper.git"
+  },
+  "homepage": "https://github.com/flakiness/podkeeper",
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "@degulabs/build": "^0.0.1",
     "@playwright/test": "^1.48.2",