Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Atinux committed Jan 9, 2024
1 parent d4171c2 commit d440d97
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,26 @@
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]

> Gather components metadata on build time and make them available on production
💡 This module depends on `nuxt3`
Gather components metadata on build time and make them available on production. This module is developed to give a visual Markdown Editor with Vue Components in it for [Nuxt Studio](https://nuxt.studio).

## Quick Setup

1. Add `nuxt-component-meta` dependency to your project:

```bash
# Using PNPM
pnpm add -D nuxt-component-meta
pnpm add nuxt-component-meta

# Using NPM
npm install --save-dev nuxt-component-meta
npm install nuxt-component-meta
```

2. Add `nuxt-component-meta` to the `modules` section of your `nuxt.config.js`
2. Add `nuxt-component-meta` to the `modules` section of your `nuxt.config.ts`

```ts
{
export default defineNuxtConfig({
modules: ['nuxt-component-meta']
}
})
```

## Usage
Expand All @@ -44,6 +42,14 @@ const { data: meta } = await useAsyncData('my-component', () => $fetch('/api/com
</script>
```

## Nightly Builds

You can install the latest nightly build of the Studio module by running:

```bash
npm i nuxt-component-meta@nightly
```

<!-- Badges -->
[npm-version-src]: https://img.shields.io/npm/v/nuxt-component-meta/latest.svg?style=flat&colorA=002438&colorB=28CF8D
[npm-version-href]: https://npmjs.com/package/nuxt-component-meta
Expand Down
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@
"files": [
"dist"
],
"keywords": [
"vue",
"nuxt",
"vue component",
"nuxt component"
],
"scripts": {
"prepack": "nuxt-module-build build",
"dev": "nuxi dev playground",
Expand Down

0 comments on commit d440d97

Please sign in to comment.