update readme

master
Conduitry 4 years ago
parent e9d60d043b
commit 42483eb345
  1. 8
      README.md

@ -1,6 +1,6 @@
# docker-windows-watch
Another shim to allow Linux containers running on Docker for Windows to watch for file changes in bind mounts. This shim requires a recent version of Node.js, but has no other dependencies.
Another shim to allow Linux containers running on Docker for Windows to watch for file changes in bind mounts. This requires Node.js 8+, but has no other dependencies.
## Usage
@ -10,7 +10,7 @@ Watches the bind mounts of all running containers, and monitors the starting and
`node.exe docker-windows-watch.js container_name container_name...`
If you specify one or more container names or ids, all bind mounts on these containers will be watched. The starting and stopping of containers will not be monitored.
If you specify one or more container names or ids, only bind mounts on these containers will be watched. The starting and stopping of containers is still monitored.
## Limitations
@ -18,8 +18,8 @@ Probably many. This is a very new tool. No error handling. No sanity checking of
## Under the hood
This tool directly queries the Docker Engine API to look up containers, find running containers, monitor starting/stopping containers, and send commands to containers. It finds all of the bind mounts for the appropriate container(s), and determines the real Windows path and the Linux container's path to each one. It uses `fs.watch` to watch the directory from within Windows. For each change, it sends `chmod + /mounted/path/of/modified.file` to the container.
This tool directly queries the Docker Engine API to look up containers, monitor starting/stopping containers, and send commands to them. It finds all of the bind mounts for the appropriate container(s), and determines the real Windows path and the Linux container's path for each one. It uses `fs.watch` to watch the directory from within Windows, and for each change it sends a `chmod + /mounted/path/of/modified.file` to the container.
## License
The Unlicense.
[The Unlicense](LICENSE).