Skip to content

Commit

Permalink
fix: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivan-kalachikov committed Jun 12, 2024
1 parent 038ca8b commit 5a88455
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 15 deletions.
23 changes: 9 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ This module is designed for use with the VirtoCommerce frontend app. It provides
install the latest version

```bash
yarn add vc-module-front-hotjar@git@github.com:VirtoCommerce/vc-module-front-hotjar.git
yarn add vc-modules-front-hotjar
```

or install a specific version

```bash
yarn add vc-module-front-hotjar@git@github.com:VirtoCommerce/vc-module-front-hotjar.git#v1.0.0
yarn add vc-modules-front-hotjar@1.0.1
```

## Usage
Expand All @@ -23,13 +23,13 @@ yarn add vc-module-front-hotjar@git@github.com:VirtoCommerce/vc-module-front-hot
Import the `useHotjarModule` composable in your Vue component:

```ts
import { useHotjarModule } from "vc-module-front-hotjar";
import { useHotjarModule } from "vc-modules-front-hotjar";
```

but preferably use async import

```ts
const { useHotjarModule } = await import("vc-module-front-hotjar");
const { useHotjarModule } = await import("vc-modules-front-hotjar");
```

### Initialize Hotjar
Expand All @@ -40,23 +40,18 @@ To initialize Hotjar, call the `initModule` method with the appropriate properti
const { initModule } = useHotjarModule();

initModule({
settings: {
id: "hotjar_site_id",
version: "6",
},
dependencies: {
canUseDOM,
isDevelopment: IS_DEVELOPMENT,
logger: Logger,
userId: user.value.id,
},
getModuleSettings,
isDevelopment: IS_DEVELOPMENT,
logger: Logger,
userId: user.value.id,
});
```

## Links

- [Hotjar](https://www.hotjar.com/)
- [Hotjar Module](https://github.com/VirtoCommerce/vc-module-hotjar)
- [Npm module](https://www.npmjs.com/package/vc-modules-front-hotjar)

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vc-modules-front-hotjar",
"version": "1.0.12",
"version": "1.0.13",
"main": "index.ts",
"repository": {
"type": "git",
Expand Down

0 comments on commit 5a88455

Please sign in to comment.