docs: Sync readme [ci skip]

sya-ri · Sep 5, 2024 · 952197f · 952197f
1 parent 21ca562
commit 952197f
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -239,7 +239,6 @@ The lower the number, the higher the priority.
 | disableLogging | Disable logging on generation.                                        |
 | emoji          | Use emojis in logs.                                                   |
 
-
 ## 👏 Acknowledgments
 
 This project was inspired by and references implementation patterns from the [TanStack Router](https://tanstack.com/router) package.

diff --git a/packages/css-var-extract-cli/README.md b/packages/css-var-extract-cli/README.md
@@ -200,7 +200,17 @@ cve watch
 You can create `cve.config.json` and change settings.
 If you are using a plugin, it also supports inline configuration.
 
-### cve.config.json
+You can also override the settings by the `CVE_CONFIG` environment variable.
+
+### Priority
+
+The lower the number, the higher the priority.
+
+1. Environment variable: `CVE_CONFIG`
+2. Inline config
+3. File config `cve.config.json`
+
+### JSON
 
 ```json
 {
@@ -214,10 +224,21 @@ If you are using a plugin, it also supports inline configuration.
   ],
   "fileFooter": [
     "/* prettier-ignore-end */"
-  ]
+  ],
+  "disableLogging": false,
+  "emoji": true
 }
 ```
 
+| Option         | Description                                                           |
+|----------------|-----------------------------------------------------------------------|
+| files          | CSS files that collects css variables. Set relative or absolute path. |
+| output         | Path to generate the Typescript file. Set relative or absolute path.  |
+| fileHeader     | Header of the generated file.                                         |
+| fileFooter     | Footer of the generated file.                                         |
+| disableLogging | Disable logging on generation.                                        |
+| emoji          | Use emojis in logs.                                                   |
+
 ## 👏 Acknowledgments
 
 This project was inspired by and references implementation patterns from the [TanStack Router](https://tanstack.com/router) package.

diff --git a/packages/css-var-extract-plugin/README.md b/packages/css-var-extract-plugin/README.md
@@ -200,7 +200,17 @@ cve watch
 You can create `cve.config.json` and change settings.
 If you are using a plugin, it also supports inline configuration.
 
-### cve.config.json
+You can also override the settings by the `CVE_CONFIG` environment variable.
+
+### Priority
+
+The lower the number, the higher the priority.
+
+1. Environment variable: `CVE_CONFIG`
+2. Inline config
+3. File config `cve.config.json`
+
+### JSON
 
 ```json
 {
@@ -214,10 +224,21 @@ If you are using a plugin, it also supports inline configuration.
   ],
   "fileFooter": [
     "/* prettier-ignore-end */"
-  ]
+  ],
+  "disableLogging": false,
+  "emoji": true
 }
 ```
 
+| Option         | Description                                                           |
+|----------------|-----------------------------------------------------------------------|
+| files          | CSS files that collects css variables. Set relative or absolute path. |
+| output         | Path to generate the Typescript file. Set relative or absolute path.  |
+| fileHeader     | Header of the generated file.                                         |
+| fileFooter     | Footer of the generated file.                                         |
+| disableLogging | Disable logging on generation.                                        |
+| emoji          | Use emojis in logs.                                                   |
+
 ## 👏 Acknowledgments
 
 This project was inspired by and references implementation patterns from the [TanStack Router](https://tanstack.com/router) package.

diff --git a/packages/css-var-extract/README.md b/packages/css-var-extract/README.md
@@ -200,7 +200,17 @@ cve watch
 You can create `cve.config.json` and change settings.
 If you are using a plugin, it also supports inline configuration.
 
-### cve.config.json
+You can also override the settings by the `CVE_CONFIG` environment variable.
+
+### Priority
+
+The lower the number, the higher the priority.
+
+1. Environment variable: `CVE_CONFIG`
+2. Inline config
+3. File config `cve.config.json`
+
+### JSON
 
 ```json
 {
@@ -214,10 +224,21 @@ If you are using a plugin, it also supports inline configuration.
   ],
   "fileFooter": [
     "/* prettier-ignore-end */"
-  ]
+  ],
+  "disableLogging": false,
+  "emoji": true
 }
 ```
 
+| Option         | Description                                                           |
+|----------------|-----------------------------------------------------------------------|
+| files          | CSS files that collects css variables. Set relative or absolute path. |
+| output         | Path to generate the Typescript file. Set relative or absolute path.  |
+| fileHeader     | Header of the generated file.                                         |
+| fileFooter     | Footer of the generated file.                                         |
+| disableLogging | Disable logging on generation.                                        |
+| emoji          | Use emojis in logs.                                                   |
+
 ## 👏 Acknowledgments
 
 This project was inspired by and references implementation patterns from the [TanStack Router](https://tanstack.com/router) package.