Version 2.0.0

README.md

@@ -149,10 +149,22 @@ Now the `.autocorrectrc` file has created.
 Config file example:
 
 ```yml
-# Config for Speelcheck
+# Config rules
+rules:
+  # Auto add spacing between CJK (Chinese, Japanese, Korean) and English words.
+  # 0 - off, 1 - error, 2 - warning
+  space-word: 1
+  # Add space between some punctuations.
+  space-punctuation: 1
+  # Convert to fullwidth.
+  fullwidth: 1
+  # Convert to halfwidth.
+  halfwidth: 1
+  # To remove space near the fullwidth.
+  no-space-fullwidth: 1
+  # Spellcheck
+  spellcheck: 2
 spellcheck:
-  # 0 - Disabled, 1 - Format and Lint, 2 - LintOnly
-  mode: 1
   # Correct Words (Case insensitive) for by Spellcheck
   words:
     - GitHub
@@ -211,16 +223,11 @@ function hello() {
 
 #### Disable some rules
 
-You can use `autocorrect-disable <rule>` in comment to disable some rules.
+> Since: 2.0
 
-Rules:
+You can use `autocorrect-disable <rule>` in comment to disable some rules.
 
-- `space-word` - Disable to add space between words.
-- `space-punctuation` - Disable to add space between some punctuations.
-- `no-space-fullwidth` - Disable to remove space near the fullwidth.
-- `fullwidth` - Disable to convert to fullwidth.
-- `halfwidth` - Disable to convert to halfwidth.
-- `spellcheck` - Disable to check spell.
+> Rule names please see: [Configuration](#configuration)
 
 ```js
 function hello() {

autocorrect-cli/Cargo.toml

@@ -7,7 +7,7 @@ license = "MIT"
 name = "autocorrect-cli"
 readme = "../README.md"
 repository = "https://github.com/huacnlee/autocorrect"
-version = "1.11.0"
+version = "2.0.0"
 
 [[bin]]
 name = "autocorrect"

autocorrect-wasm/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 edition = "2021"
 name = "autocorrect-wasm"
-version = "1.11.0"
+version = "2.0.0"
 
 [lib]
 crate-type = ["cdylib", "rlib"]

autocorrect/.autocorrectrc.default

@@ -1,11 +1,18 @@
 rules:
+  # Auto add spacing between CJK (Chinese, Japanese, Korean) and English words.
+  # 0 - off, 1 - error, 2 - warning
   space-word: 1
+  # Add space between some punctuations.
   space-punctuation: 1
+  # Convert to fullwidth.
   fullwidth: 1
+  # Convert to halfwidth.
   halfwidth: 1
+  # To remove space near the fullwidth.
   no-space-fullwidth: 1
+  # Spellcheck
   spellcheck: 2
 spellcheck:
   words:
     # Please do not add a general English word (eg. apple, python) here.
-    # Users can add their special words to their .autocorrectrc file by their need.
+    # Users can add their special words to their .autocorrectrc file by their need.

autocorrect/Cargo.toml

@@ -8,7 +8,7 @@ license = "MIT"
 name = "autocorrect"
 readme = "../README.md"
 repository = "https://github.com/huacnlee/autocorrect"
-version = "1.11.0"
+version = "2.0.0"
 
 [lib]
 name = "autocorrect"