Skip to content

Commit

Permalink
chore: add basic description
Browse files Browse the repository at this point in the history
  • Loading branch information
ijkml committed Apr 12, 2024
1 parent e4523eb commit 25a766b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Find and replace all on all files (CMD+SHIFT+F):
[![License][license-src]][license-href]
[![Nuxt][nuxt-src]][nuxt-href]

My new Nuxt module for doing amazing things.
Umami Module for Nuxt

- [ Release Notes](/CHANGELOG.md)
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nu-ma?file=playground%2Fapp.vue) -->
Expand All @@ -37,39 +37,37 @@ npx nuxi module add nu-ma

That's it! You can now use Nuxt Umami in your Nuxt app ✨


## Contribution

<details>
<summary>Local development</summary>

```bash
# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release
```

</details>


<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/nu-ma/latest.svg?style=flat&colorA=020420&colorB=00DC82
[npm-version-href]: https://npmjs.com/package/nu-ma
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "nu-ma",
"type": "module",
"version": "0.0.0",
"description": "My new Nuxt module",
"description": "Umami module for Nuxt",
"license": "MIT",
"repository": "ijkml/nu-ma",
"exports": {
Expand Down

0 comments on commit 25a766b

Please sign in to comment.