Update makefile and documentation

Author: nedix

Makefile

@@ -1,15 +1,14 @@
 setup:
 	@docker build --progress=plain -f Containerfile -t mermerd .
 
+run: STORAGE_DIRECTORY   = "$(CURDIR)/storage/"
 run:
-	@touch output.mmd
-	@docker run --rm -it --net host \
-		--mount type=bind,source="$(CURDIR)"/examples/mermerd-config.yaml,target=/root/.mermerd \
-		--mount type=bind,source="$(CURDIR)"/output.mmd,target=/root/result.mmd \
+	@docker run --rm -it \
+		--net host \
+		-v "$(STORAGE_DIRECTORY):/mnt/storage/" \
 		mermerd \
-		--runConfig "/root/.mermerd" \
+		--runConfig "/etc/mermerd/config.yml" \
 		--connectionString "mysql://root:@tcp(host.docker.internal:3306)/mysql"
 
 test:
-	@$(MAKE) setup
-	@tests/index.sh
+	@$(CURDIR)/tests/index.sh

README.md

@@ -1,42 +1,24 @@
-# [mermerd-container](https://github.com/nedix/mermerd-container)
+# [mermerd-container][project]
 
 Create [Mermaid] ERD diagrams from live databases.
 
-## Usage
-
-#### 1. Create an output file
-
-```shell
-touch output.mmd
-```
 
-#### 2. (Optional) Create a mermerd configuration file
+## Usage
 
-See 
-[documentation](https://github.com/KarnerTh/mermerd?tab=readme-ov-file#global-configuration-file)
-and
-[examples/mermerd-config.yaml](https://github.com/nedix/mermerd-container/blob/main/examples/mermerd-config.yaml)
-.
 
-#### 3. Run the mermerd command-line interface
+### 3. Run the mermerd command-line utility
 
 This example command connects to a MySQL server running on localhost port 3306.
 Replace `root:` with your `username:password` combination.
 
 ```shell
-docker run --pull always --rm -it --name mermerd \
+docker run --rm -it --pull always --name mermerd \
     --net host \
-    --mount type=bind,source="${PWD}"/output.mmd,target=/root/result.mmd \
-    --mount type=bind,source="${PWD}"/mermerd-config.yaml,target=/root/.mermerd \ # optional
-    nedix/mermerd \
+    -v "${PWD}/storage/:/mnt/storage/" \
+    mermerd \
+    --runConfig "/etc/mermerd/config.yml" \
     --connectionString "mysql://root:@tcp(host.docker.internal:3306)/mysql"
 ```
 
-<hr>
-
-## Attribution
-
-Powered by [mermerd].
 
-[mermaid]: https://mermaid.js.org
-[mermerd]: https://github.com/KarnerTh/mermerd
+[project]: https://hub.docker.com/r/nedix/mermerd

docs/make.md

@@ -0,0 +1,29 @@
+# Make
+
+## Available commands
+
+### Setup
+
+Build the container.
+
+Command: `make setup`
+
+
+### Run
+
+Start the container.
+
+Command: `make run`
+
+Options:
+
+| Option key          | Default value              |
+|---------------------|----------------------------|
+| STORAGE_DIRECTORY   | ./storage/                 |
+
+
+### Test
+
+Run all tests.
+
+Command: `make test`

examples/mermerd-config.yaml renamed to rootfs/etc/mermerd/config.yml

@@ -10,8 +10,8 @@ omitAttributeKeys: true
 # omit the constraint labels
 omitConstraintLabels: true
 
-# output file name (default "result.mmd")
-outputFileName: "result.mmd"
+# output file name
+outputFileName: "/mnt/storage/output.mmd"
 
 # schema that should be used
 schema:

storage/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore