From d691dd9c1ee86031196b8f096bcc15f03fc622a4 Mon Sep 17 00:00:00 2001
From: "hy.li" <hy.li@hcr.com.cn>
Date: Sat, 29 Jul 2023 09:40:47 +0800
Subject: [PATCH] update README

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index f8db80a80..2bff88b55 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,24 @@ # Step 3: Clone the repository to your local machine, and install it.
 python setup.py install
 ```
 
+**Note:**
+
+- If already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment variable
+`PUPPETEER_SKIP_CHROMIUM_DOWNLOAD` to `true`.
+
+- Some people are [having issues](https://github.com/mermaidjs/mermaid.cli/issues/15) installing this tool globally. Installing it locally is an alternative solution,
+
+    ```bash
+    npm install @mermaid-js/mermaid-cli
+    ```
+
+- don't forget to the configuration for mmdc in config.yml
+
+    ```yml
+    PUPPETEER_CONFIG: "./puppeteer-config.json"
+    MMDC: "./node_modules/.bin/mmdc"
+    ```
+
 ### Installation by Docker
 
 ```bash