Merge pull request #109 from koliveira15/105-nx-compatibility-table

Nx compatibility documentation
koliveira15 · May 23, 2024 · 991ee6b · 991ee6b
2 parents 19b582f + b127205
commit 991ee6b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/apps/docs-site/src/content/docs/reference/compatibility.mdx b/apps/docs-site/src/content/docs/reference/compatibility.mdx
@@ -0,0 +1,21 @@
+---
+title: Compatibility
+---
+
+import { Code } from '@astrojs/starlight/components';
+export const output = `{
+  '@nx/devkit': '>= 16 < 19',
+  '@phenomnomnominal/tsquery': '5.0.1',
+  'sonarqube-scanner': '3.1.0',
+  nx: '>= 16 < 20',
+  tslib: '>= 2.3.0 < 3
+}`;
+
+For compatibilities with Nx versions, you can check the [Releases](https://github.com/koliveira15/nx-sonarqube/releases)
+page in GitHub or run the following command where `x.x.x` is the semver version of the package:
+
+```shell
+npm info @koliveira15/nx-sonarqube@x.x.x peerDependencies
+```
+
+<Code code={output} lang="json" title="output" mark="nx: '>= 16 < 20'" />
diff --git a/packages/nx-sonarqube/README.md b/packages/nx-sonarqube/README.md
@@ -1,5 +1,3 @@
 # @koliveira15/nx-sonarqube
 
-![logo](https://i.ibb.co/R0bzqtP/nx-sonarqube.png)
-
-[See Documentation](https://github.com/koliveira15/nx-sonarqube)
+[Documentation](https://nx-sonarqube.dev/)