docs: add contributing docs

Author: johanbook

.github/workflows/nodejs.yaml

@@ -32,7 +32,7 @@ jobs:
           if [[ $GITHUB_REF == refs/tags/* ]]; then
             VERSION=${GITHUB_REF#refs/tags/v}
           fi
-          TAGS="${DOCKER_IMAGE}:${VERSION},${DOCKER_IMAGE}:${SHORTREF}"
+          TAGS="${DOCKER_IMAGE}:${VERSION}"
 
           # If the VERSION looks like a version number, assume that
           # this is the most recent version of the image and also

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+## Technological stack
+
+The project uses the Nodejs runtime environment but aims to use minimal
+dependencies in order to create small bundle sizes.
+
+## Git methodology
+
+This project uses `main` as development branch. New features are committed
+through feature branches and merged into main through pull requests.
+
+## Release management
+
+This project uses [semver](https://semver.org/), handled by the NPM package
+[standard-version](https://www.npmjs.com/package/standard-version). For creating
+a new release, run the following commands:
+
+```sh
+npm run release
+git push --follow-tags origin main
+```

README.md

@@ -3,9 +3,9 @@
 _This software has not been tested in regards of security and should not be used
 in a production environment_
 
-**file-server-domain** is a simplistic Nodejs file server supporting multiple
-domains. It is mainly intended to run an internal network with its own DNS
-server.
+**file-domain-server** is a simplistic Nodejs HTTP file server that serve
+different folders depending on the HTTP `Host` header. It is mainly intended to
+run an internal network with its own DNS server.
 
 ## Configuration
 
@@ -29,6 +29,15 @@ build/mycat.com/index.html
 build/mycat.com/script.js
 ```
 
+### Environmental variables
+
+The following can be configured as environment variables:
+
+- **DEFAULT_INDEX_FILE** name of file served on paths ending with a trailing
+  slash (default `index.html`).
+- **PORT** the port the server should listen on (default 8080).
+- **ROOT_FILE_PATH** root directory of served file tree (default `build`).
+
 ## Docker
 
 The server can be run through Docker
@@ -41,3 +50,8 @@ docker run \
 	--volume ${PWD}/build/:/app/build/ \
 	johanbook/file-domain-server:latest
 ```
+
+## Contributing
+
+For contributions and development procedures, see the
+[contributions file](./CONTRIBUTING.md).