From ac865efa9563d4b9fa18910a67a40512625d43ec Mon Sep 17 00:00:00 2001 From: Firq Date: Fri, 29 Dec 2023 13:05:18 +0100 Subject: [PATCH] Updated README --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 867e2c8..2e08ab3 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# Placeholder \ No newline at end of file +# website-serve Docker Image + +This is a simple `node:lts` based Docker Image with the `serve` fork of `@warren-bank` already preinstalled. +It can be used to serve static files like websites. + +## Usage + +To use the `serve` process, run the following `CMD` at the end of your own docker image: + +```dockerfile +CMD [ "serve", DIRECTORY, "-p", PORT ] +``` + +Replace the values for `DIRECTORY` and `PORT` accordingly. + +It is recommended to include a `serve.json` file inside the `DIRECTORY`.
+The syntax for this can be found [here](https://github.com/warren-bank/node-serve/tree/master/lib/serve-handler)