diff --git a/README.md b/README.md index f8f7b61c95ae4bd3fcab20feee0b3d62485fa2f6..bd0c8510d36cd7d2d6fe0e8ac94cffb95a77ba29 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,18 @@ Once the installation step is completed, you need to declare the module. To do t declare module "@metabohub/viz-core"; ``` +### Nuxt + +If you are using this package in a [Nuxt](https://nuxt.com/) project, you need to use the package **in a component** and wrap this component with [ClientOnly](https://nuxt.com/docs/api/components/client-only). + +```html +<!-- /pages/pageThatDisplayANetwork.vue --> +<ClientOnly> + <MyComponentUsingNetwork /> +</ClientOnly> +``` + +Importing the package directly in the page instead of a component will **result in an error**. ## Usage