Merge pull request #339 from jihchi/add_docker_run_to_readme

Add docker run to readme
jihchi · Apr 8, 2024 · dbdbd2c · dbdbd2c
2 parents f9cce80 + 5eb6175
commit dbdbd2c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,6 +14,16 @@ DEBUG=app:* pnpm start
 
 Go to http://localhost:3000
 
+## Launch a container
+
+See [here](https://github.com/jihchi/mermaid.ink/pkgs/container/mermaid.ink) for supported tags.
+
+```
+docker run --cap-add=SYS_ADMIN ghcr.io/jihchi/mermaid.ink
+```
+
+Go to http://localhost:3000
+
 ## Troubleshooting
 
 ### I'm getting back `HTTP 431 Request Header Fields Too Large` error

diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
   "author": "jihchi",
   "main": "src/index.js",
   "scripts": {
-    "format": "prettier --with-node-modules --write \"{src,test}/**/*.{mjs,js,html}\" \"*.{js,cjs,mjs}\"",
+    "format": "prettier --with-node-modules --write \"{src,test}/**/*.{mjs,js,html}\" \"*.{js,cjs,mjs,md}\"",
     "start": "node src/index.js",
     "test": "jest",
     "test:watch": "pnpm test --watch"