Skip to content

Commit

Permalink
chore: update module name
Browse files Browse the repository at this point in the history
  • Loading branch information
carlesmitjans committed Jan 12, 2024
1 parent 27956f7 commit 16796ce
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- [ Release Notes](https://posthog.nuxtjs.org/changelog)
- [📖  Documentation](https://posthog.nuxtjs.org)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/@nuxtjs/posthog?file=playground%2Fapp.vue) -->
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nuxt-posthog?file=playground%2Fapp.vue) -->

## Features

Expand All @@ -22,24 +22,24 @@

## Quick Setup

1. Add `@nuxtjs/posthog` dependency to your project
1. Add `nuxt-posthog` dependency to your project

```bash
# Using pnpm
pnpm add -D @nuxtjs/posthog
pnpm add -D nuxt-posthog

# Using yarn
yarn add --dev @nuxtjs/posthog
yarn add --dev nuxt-posthog

# Using npm
npm install --save-dev @nuxtjs/posthog
npm install --save-dev nuxt-posthog
```

2. Add `@nuxtjs/posthog` to the `modules` section of `nuxt.config.ts`
2. Add `nuxt-posthog` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
modules: ['@nuxtjs/posthog'],
modules: ['nuxt-posthog'],
});
```

Expand Down Expand Up @@ -73,11 +73,11 @@ pnpm run release

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/posthog/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/@nuxtjs/posthog
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/posthog.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/posthog
[license-src]: https://img.shields.io/npm/l/@nuxtjs/posthog.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/@nuxtjs/posthog
[npm-version-src]: https://img.shields.io/npm/v/nuxt-posthog/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-posthog
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-posthog.svg?style=flat&colorA=18181B&colorB=28CF8D
[npm-downloads-href]: https://npmjs.com/package/nuxt-posthog
[license-src]: https://img.shields.io/npm/l/nuxt-posthog.svg?style=flat&colorA=18181B&colorB=28CF8D
[license-href]: https://npmjs.com/package/nuxt-posthog
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
[nuxt-href]: https://nuxt.com
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@nuxtjs/posthog",
"name": "nuxt-posthog",
"version": "1.1.0",
"description": "Posthog module for nuxt",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion playground/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"private": true,
"name": "@nuxtjs/posthog-playground",
"name": "nuxt-posthog-playground",
"type": "module",
"scripts": {
"dev": "nuxi dev",
Expand Down
2 changes: 1 addition & 1 deletion src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface ModuleOptions {

export default defineNuxtModule<ModuleOptions>({
meta: {
name: '@nuxtjs/posthog',
name: 'nuxt-posthog',
configKey: 'posthog',
},
defaults: {
Expand Down
4 changes: 2 additions & 2 deletions test/fixtures/basic/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { resolve } from 'path';

export default defineNuxtConfig({
alias: {
'@nuxtjs/posthog': resolve(__dirname, '../../../src/module.ts'),
'nuxt-posthog': resolve(__dirname, '../../../src/module.ts'),
},
modules: ['@nuxtjs/posthog'],
modules: ['nuxt-posthog'],
});

0 comments on commit 16796ce

Please sign in to comment.