docs: add string variant of .edit

Author: marionebl

docs/reference-api.md

@@ -213,9 +213,12 @@ load({parserPreset: './parser-preset.js'})
 
 ```ts
 type Range = {
+  /* Lower end of the commit range to read */
   from: string;
+  /* Upper end of the commit range to read */
   to: string;
-  edit?: boolean;
+  /* Wether (boolean) to read from ./.git/COMMIT_EDITMSG or where to read from (string) */
+  edit?: boolean | string;
 };
 
 read(range: Range) => Promise<string[]>
@@ -231,6 +234,10 @@ read({edit: true})
  .then(messages => console.log(messages));
 // => ['I did something\n\n']
 
+read({edit: './git/GITGUI_EDITMESSAGE'})
+ .then(messages => console.log(messages));
+// => ['I did something via git gui\n\n']
+
 read({from: 'HEAD~2'})
   .then(messages => console.log(messages));
 // => ['I did something\n\n', 'Initial commit\n\n']

docs/reference-cli.md

@@ -1,23 +1,17 @@
 # CLI
 
-## Installation
-
 ```bash
-npm install --save-dev @commitlint/cli
-```
+❯ npx commitlint --help
 
-## Usage
-
-```bash
-❯ commitlint --help
-  commitlint - Lint commit messages
+[email protected] - Lint your commit messages
 
-  [input] reads from stdin if --edit, --from, --to are omitted
-  --color, -c          toggle formatted output, defaults to: true
-  --edit, -e           read last commit message found in ./.git/COMMIT_EDITMSG
-  --extends, -x        array of resolvable ids pointing to shareable configurations to extend
-  --from, -f           lower end of the commit range to lint; applies if edit=false
-  --to, -t             upper end of the commit range to lint; applies if edit=false
-  --quiet, -q          toggle console output
-  --parser-preset, -p  resolvable id to load and pass to conventional-commits-parser
+  [input] reads from stdin if --edit, --from and --to are omitted
+  --color, -c            toggle colored output, defaults to: true
+  --cwd, -d              directory to execute in, defaults to: /Users/marneb/Documents/oss/commitlint
+  --edit, -e             read last commit message from the specified file or fallbacks to ./.git/COMMIT_EDITMSG
+  --extends, -x          array of shareable configurations to extend
+  --from, -f             lower end of the commit range to lint; applies if edit=false
+  --to, -t               upper end of the commit range to lint; applies if edit=false
+  --quiet, -q            toggle console output
+  --parser-preset, -p    configuration preset to use for conventional-commits-parser
 ```