Skip to content

Commit ddaa37b

Browse files
committed
docs: some api differnces in the readme
1 parent 63fd2ab commit ddaa37b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,15 @@ This setup creates a connection between the launched container and its owner. Wh
1212

1313
## PodKeeper vs. TestContainers
1414

15-
Both PodKeeper and [TestContainers](https://testcontainers.com/) address the problem of starting, stopping, and cleaning up Docker containers:
15+
Both PodKeeper and [TestContainers](https://testcontainers.com/) provide solutions for starting, stopping, and cleaning up Docker containers:
1616

17-
- **TestContainers** uses a dedicated Docker container called "Ryuk" to handle cleanup.
18-
- **PodKeeper** manages cleanup using a [dead man's switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch) mechanism.
17+
- **TestContainers** uses a dedicated Docker container called "Ryuk" to manage cleanup.
18+
- **PodKeeper** relies on a [dead man's switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch) mechanism for cleanup.
19+
20+
While TestContainers is a mature, industry-proven tool, PodKeeper is an experimental alternative that explores a different approach.
21+
22+
There are also some notable differences in API design philosophy:
23+
24+
- **Process Behavior**: PodKeeper services prevent the Node.js process from exiting, while TestContainers services do not.
25+
- **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.
1926

20-
While TestContainers is a well-established solution with a solid industry record, PodKeeper is an experimental approach exploring an alternative cleanup method.

0 commit comments

Comments
 (0)