docs: update readme with latest changes

Author: Narretz

README.md

@@ -28,7 +28,8 @@ Table of Contents
 <!-- MarkdownTOC autolink="true" -->
 
 - [Install](#install)
-  - [Plugin file](#plugin-file)
+  - [Support file](#support-file)
+  - [Config file](#config-file)
 - [Usage Overview](#usage-overview)
 - [Filter by test title](#filter-by-test-title)
   - [OR substring matching](#or-substring-matching)
@@ -38,8 +39,9 @@ Table of Contents
   - [Tags in the test config object](#tags-in-the-test-config-object)
   - [AND tags](#and-tags)
   - [OR tags](#or-tags)
-  - [Test suites](#test-suites-1)
-  - [Invert tag](#invert-tag)
+  - [Inverted tags](#inverted-tags)
+  - [NOT tags](#not-tags)
+  - [Tags in test suites](#tags-in-test-suites)
   - [Grep untagged tests](#grep-untagged-tests)
 - [Pre-filter specs \(grepFilterSpecs\)](#pre-filter-specs-grepfilterspecs)
 - [Omit filtered tests \(grepOmitFiltered\)](#omit-filtered-tests-grepomitfiltered)
@@ -56,6 +58,7 @@ Table of Contents
 - [See also](#see-also)
 - [Migration guide](#migration-guide)
   - [from v1 to v2](#from-v1-to-v2)
+  - [from v2 to v3](#from-v2-to-v3)
 - [Videos & Blog Posts](#videos--blog-posts)
 - [Blog posts](#blog-posts)
 - [Small print](#small-print)
@@ -65,7 +68,7 @@ Table of Contents
 
 ## Install
 
-Assuming you have Cypress installed, add this module as a dev dependency
+Assuming you have Cypress installed, add this module as a dev dependency.
 
 ```shell
 # using NPM
@@ -74,7 +77,10 @@ npm i -D cypress-grep
 yarn add -D cypress-grep
 ```
 
+**Note**: cypress-grep only works with Cypress version >= 10.
+
 ### Support file
+
 **required:** load this module from the [support file](https://on.cypress.io/writing-and-organizing-tests#Support-file) or at the top of the spec file if not using the support file. You improve the registration function and then call it:
 
 ```js
@@ -89,7 +95,6 @@ import registerCypressGrep from 'cypress-grep'
 registerCypressGrep()
 ```
 
-
 ### Config file
 
 **optional:** load and register this module from the [config file](https://docs.cypress.io/guides/references/configuration#setupNodeEvents):
@@ -259,41 +264,59 @@ You can run tests that match one tag or another using spaces. Make sure to quote
 --env grepTags='@slow @critical'
 ```
 
-### Test suites
+### Inverted tags
 
-The tags are also applied to the "describe" blocks. In that case, the tests look up if any of their outer suites are enabled.
+You can skip running the tests with specific tag using the invert option: prefix the tag with the character `-`.
 
-```js
-describe('block with config tag', { tags: '@smoke' }, () => {})
 ```
+# do not run any tests with tag "@slow"
+--env grepTags=-@slow
+```
+
+If you want to run all tests with tag `@slow` but without tag `@smoke`:
 
 ```
-# run any tests in the blocks having "@smoke" tag
---env grepTags=@smoke
-# skip any blocks with "@smoke" tag
---env grepTags=-@smoke
+--env grepTags=@slow+-@smoke
 ```
 
-See the [cypress/integration/describe-tags-spec.js](./cypress/integration/describe-tags-spec.js) file.
+**Note:** Inverted tag filter is not compativle with the `grepFilterSpecs` option
 
-**Note:** global function `describe` and `context` are aliases and both supported by this plugin.
+### NOT tags
 
-### Invert tag
+You can skip running the tests with specific tag, even if they have a tag that should run, using the not option: prefix the tag with `--`.
 
-You can skip running the tests with specific tag using the invert option: prefix the tag with the character `-`.
+Note this is the same as appending `+-<tag to never run>` to each tag. May be useful with large number of tags.
+
+If you want to run tests with tags `@slow` or `@regression` but without tag `@smoke`
 
 ```
-# do not run any tests with tag "@slow"
---env grepTags=-@slow
+--env grepTags='@slow @regression --@smoke'
 ```
 
-If you want to run all tests with tag `@slow` but without tag `@smoke`:
+which is equivalent to
 
 ```
---env grepTags=@slow+-@smoke
+--env grepTags='@slow+-@smoke @regression+-@smoke'
 ```
 
-**Note:** Inverted tag filter is not compativle with the `grepFilterSpecs` option
+### Tags in test suites
+
+The tags are also applied to the "describe" blocks. In that case, the tests look up if any of their outer suites are enabled.
+
+```js
+describe('block with config tag', { tags: '@smoke' }, () => {})
+```
+
+```
+# run any tests in the blocks having "@smoke" tag
+--env grepTags=@smoke
+# skip any blocks with "@smoke" tag
+--env grepTags=-@smoke
+```
+
+See the [cypress/integration/describe-tags-spec.js](./cypress/integration/describe-tags-spec.js) file.
+
+**Note:** global function `describe` and `context` are aliases and both supported by this plugin.
 
 ### Grep untagged tests
 
@@ -363,7 +386,7 @@ cypress run --env grep="works 2",grepOmitFiltered=true
 
 ## Disable grep
 
-If you specify the `grep` parameters inside `cypress.json` file, you can disable it from the command line
+If you specify the `grep` parameters the [config file](https://docs.cypress.io/guides/references/configuration), you can disable it from the command line
 
 ```
 $ npx cypress run --env grep=,grepTags=,burn=
@@ -562,6 +585,10 @@ The above scenario was confusing - did you want to find all tests with title con
 --env grep=hello,grepTags=smoke
 ```
 
+### from v2 to v3
+
+Version >= 3 of cypress-grep _only_ supports Cypress >= 10.
+
 ## Videos & Blog Posts
 
 Watch the video [intro to cypress-grep](https://www.youtube.com/watch?v=HS-Px-Sghd8) which shows how this repository tags tests, uses [cypress-grep](https://github.com/cypress-io/cypress-grep) plugin, and sets up the TypeScript intelligent code completion.