Skip to content

Commit 7832af9

Browse files
authored
chore: add note about version compatibility to README (#2124)
1 parent 40bc6b5 commit 7832af9

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,6 @@ You can install Nx Console in the following places:
5252
Visual Studio Marketplace.
5353
- [Nx Console for JetBrains](https://plugins.jetbrains.com/plugin/21060-nx-console) from the JetBrains Marketplace
5454

55-
### Jetbrains WSL support
56-
57-
The Node interpreter under **Languages & Frameworks** > **Node.js** needs to be configured to use the Node executable
58-
within the WSL distribution.
59-
You can read more on
60-
the [official Jetbrains docs](https://www.jetbrains.com/help/webstorm/how-to-use-wsl-development-environment-in-product.html#ws_wsl_node_interpreter_configure).
61-
6255
## True UI for Nx & Lerna
6356

6457
Nx Console is the UI for all Nx workspaces. It works for any generator or any architect commands. Nx Console does not
@@ -74,6 +67,12 @@ commands and install extensions without ever touching the terminal or having to
7467
Also, Nx Console highlights the properties you are likely to use for built-in generators and commands, so if you haven't
7568
used the CLI, you don't get overwhelmed.
7669

70+
## Compatibility
71+
72+
The latest version of Nx Console supports all Nx versions starting at Nx 15. For older versions, we cannot guarantee compatibility or full functionality. However, we welcome contributions! If you encounter specific issues with older versions, please consider submitting a PR. Of course, if you discover any problems with newer versions of Nx, please report these issues to help us improve Nx Console.
73+
74+
If you're looking to upgrade your version of Nx easily, refer to the [Nx migrate documentation](https://nx.dev/features/automate-updating-dependencies).
75+
7776
# Learn More
7877

7978
- [Documentation](https://nx.dev/core-features/integrate-with-editors) - Official documentation with video tutorials
@@ -88,3 +87,10 @@ Please read the [contributing guidelines](https://github.com/nrwl/nx-console/blo
8887
the issues from
8988
the [good first issue](https://github.com/nrwl/nx-console/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
9089
list to get started.
90+
91+
### Jetbrains WSL support
92+
93+
The Node interpreter under **Languages & Frameworks** > **Node.js** needs to be configured to use the Node executable
94+
within the WSL distribution.
95+
You can read more on
96+
the [official Jetbrains docs](https://www.jetbrains.com/help/webstorm/how-to-use-wsl-development-environment-in-product.html#ws_wsl_node_interpreter_configure).

0 commit comments

Comments
 (0)