Skip to content

Commit d440d97

Browse files
committed
chore: update readme
1 parent d4171c2 commit d440d97

File tree

2 files changed

+20
-8
lines changed

2 files changed

+20
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,26 @@
33
[![npm version][npm-version-src]][npm-version-href]
44
[![npm downloads][npm-downloads-src]][npm-downloads-href]
55

6-
> Gather components metadata on build time and make them available on production
7-
8-
💡 This module depends on `nuxt3`
6+
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).
97

108
## Quick Setup
119

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

1412
```bash
1513
# Using PNPM
16-
pnpm add -D nuxt-component-meta
14+
pnpm add nuxt-component-meta
1715

1816
# Using NPM
19-
npm install --save-dev nuxt-component-meta
17+
npm install nuxt-component-meta
2018
```
2119

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

2422
```ts
25-
{
23+
export default defineNuxtConfig({
2624
modules: ['nuxt-component-meta']
27-
}
25+
})
2826
```
2927

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

45+
## Nightly Builds
46+
47+
You can install the latest nightly build of the Studio module by running:
48+
49+
```bash
50+
npm i nuxt-component-meta@nightly
51+
```
52+
4753
<!-- Badges -->
4854
[npm-version-src]: https://img.shields.io/npm/v/nuxt-component-meta/latest.svg?style=flat&colorA=002438&colorB=28CF8D
4955
[npm-version-href]: https://npmjs.com/package/nuxt-component-meta

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@
2121
"files": [
2222
"dist"
2323
],
24+
"keywords": [
25+
"vue",
26+
"nuxt",
27+
"vue component",
28+
"nuxt component"
29+
],
2430
"scripts": {
2531
"prepack": "nuxt-module-build build",
2632
"dev": "nuxi dev playground",

0 commit comments

Comments
 (0)