Skip to content

Commit ad093b7

Browse files
committed
docs: update readme
1 parent 3f69c64 commit ad093b7

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
[![Nuxtify Docs][nuxtify-src]][nuxtify-href] -->
1414
<!-- [🏀 Online playground](https://stackblitz.com/github/nuxtify-dev/pages?file=playground%2Fapp.vue) -->
1515

16+
> [!NOTE]
17+
> **Early Access Preview:**
18+
> This module is under heavy development. While it is actively used to power a [handful of sites](https://nuxtify.dev/showcase) in production, expect things to change frequently. I will do my best to call out breaking changes in the [changelog](https://github.com/nuxtify-dev/pages/blob/main/CHANGELOG.md).
19+
1620
### Table of Contents
1721

1822
- ♾️ [Why Nuxtify?](#why-nuxtify)
@@ -26,7 +30,7 @@
2630

2731
## <a name="why-nuxtify">♾️ Why Nuxtify?</a>
2832

29-
Nuxtify is a collection of [Nuxt modules](https://nuxt.com/docs/guide/concepts/modules) that will help you stay organized, maintain focus, and _ship weirdly fast_.
33+
Nuxtify is a collection of [Nuxt modules](https://nuxt.com/docs/guide/concepts/modules) that help you stay organized, maintain focus, and _ship weirdly fast_.
3034

3135
It's built on a loosely opinionated stack that eliminates decision fatigue and ensures consistency across projects. This extensible approach gives you incredible control over your site's structure and style.
3236

@@ -52,7 +56,7 @@ Nuxtify builds on the amazing features of [Vue](https://vuejs.org/guide/introduc
5256

5357
### 💡 Intuitive UI & UX
5458

55-
- Ready to use components, page templates, sections, and layouts so you can _ship weirdly fast_
59+
- Ready to use components, page templates, and layouts so you can _ship weirdly fast_
5660
- Easily override any component with [Vuetify global defaults](https://vuetifyjs.com/en/features/global-configuration/)
5761
- Icons powered by [Material Design Icons](https://pictogrammers.com/library/mdi/) via [Vuetify icon fonts](https://vuetifyjs.com/en/features/icon-fonts/)
5862
- Fully responsive and adapts to all modern browsers and devices
@@ -71,8 +75,8 @@ Nuxtify builds on the amazing features of [Vue](https://vuejs.org/guide/introduc
7175
### 🤖 Smart SEO, Security, & Performance
7276

7377
- Fully tree shakeable for small bundle sizes
74-
- Robots, sitemaps, schema.org, social share images, broken links, and more powered by [Nuxt SEO](https://nuxtseo.com/)
7578
- Optimized caching and rendering strategies for each page with [hybrid rendering](https://nuxt.com/docs/guide/concepts/rendering#hybrid-rendering)
79+
- (coming soon) Robots, sitemaps, schema.org, social share images, broken links, and more powered by [Nuxt SEO](https://nuxtseo.com/)
7680
- (coming soon) Fast, responsive, optimized images for [20+ image providers](https://image.nuxt.com/get-started/providers) powered by [Nuxt Image](https://image.nuxt.com/)
7781
- (coming soon) Load third-party scripts with better performance, privacy, security powered by [Nuxt Scripts](https://scripts.nuxt.com/)
7882
- (coming soon) Optimal security patterns and principles powered by [Nuxt Security](https://nuxt.com/modules/security)
@@ -126,15 +130,15 @@ To see the full config, check out the [types](https://github.com/nuxtify-dev/pag
126130

127131
Nuxtify comes pre-configured with sensible defaults. Both for how the module functions and for the corresponding Nuxt [directory](https://nuxt.com/docs/guide/directory-structure).
128132

129-
If you need to override a [component](https://nuxt.com/docs/guide/directory-structure/components), [page](https://nuxt.com/docs/guide/directory-structure/pages), or [layout](https://nuxt.com/docs/guide/directory-structure/layouts), create the a file of the same name in your project (in the appropriate directory).
133+
If you need to override a [component](https://nuxt.com/docs/guide/directory-structure/components), [page](https://nuxt.com/docs/guide/directory-structure/pages), or [layout](https://nuxt.com/docs/guide/directory-structure/layouts), create the a file with the same name in your project (in the appropriate directory).
130134

131-
If you need to override a [composable](https://nuxt.com/docs/guide/directory-structure/composables) or [utils](https://nuxt.com/docs/guide/directory-structure/utils) utility function, create a function of the same name in your project (in the appropriate directory).
135+
If you need to override a [composable](https://nuxt.com/docs/guide/directory-structure/composables) or [utils](https://nuxt.com/docs/guide/directory-structure/utils) utility function, create a function with the same name in your project (in the appropriate directory).
132136

133137
## <a name="updates">✅ Updates</a>
134138

135139
[✨ Release Notes](/CHANGELOG.md)
136140

137-
It's easy to stay up to date with the latest version of Nuxtify. Just update to the latest package from your favorite package manager.
141+
It's easy to stay up to date with the latest version of Nuxtify. Just update to the latest package using your favorite package manager.
138142

139143
**Minor and patch versions**
140144
```bash
@@ -158,10 +162,9 @@ Here are a few ways you can get involved:
158162

159163
## <a name="local-development">🏠 Local Development</a>
160164

161-
<details>
162-
<summary>CLI commands</summary>
163-
164-
```bash
165+
### CLI commands
166+
167+
```bash
165168
# Install dependencies
166169
npm install
167170

@@ -180,13 +183,8 @@ Here are a few ways you can get involved:
180183
# Run Vitest
181184
npm run test
182185
npm run test:watch
183-
184-
# Release new version
185-
npm run release
186186
```
187187

188-
</details>
189-
190188
Learn about [authoring Nuxt modules](https://nuxt.com/docs/guide/going-further/modules).
191189

192190
## <a name="license">⚖️ License</a>

0 commit comments

Comments
 (0)