Skip to content
This repository was archived by the owner on Sep 24, 2025. It is now read-only.

Commit 6bdc9ce

Browse files
authored
docs(readme): update
1 parent 8516f46 commit 6bdc9ce

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
[![Codecov][codecov-src]][codecov-href]
77
[![License][license-src]][license-href] -->
88

9-
A new experience to build content-driven website with Nuxt.
9+
Official module of [Nuxt Studio](https://nuxt.studio).
1010

11-
- [ Release Notes](https://github.com/nuxtlabs/studio/releases)
12-
- [📖  Documentation](https://nuxt.studio/docs/projects/setup#requirements-to-use-the-studio-editor)
11+
A new experience to build website with [Nuxt](https://nuxt.com) and [Nuxt Content](https://content.nuxt.com/).
12+
13+
📖  Official [Documentation](https://nuxt.studio/docs/projects/setup#requirements-to-use-the-studio-editor)
1314

1415
## Features
1516

16-
- 👌  Zero configuration to start, works with any [Nuxt 3](https://nuxt.com) project
17-
- 🎨  Edit your [Pinceau tokens](https://pinceau.dev) with generated forms
18-
- ⚙️  Define your [project options](https://nuxt.com/docs/guide/directory-structure/app-config)
19-
- 🚀  Works in production with live preview
17+
- 🚀  Production [live preview](https://nuxt.studio/docs/studio/live-preview)
18+
- ⌨️  Edit your [content](https://nuxt.studio/docs/developers/content)
19+
- ⚙️  Update your [configs](https://nuxt.studio/docs/developers/app-config)
2020

2121
## Installation
2222

@@ -36,18 +36,20 @@ export default defineNuxtConfig({
3636

3737
## Configuration
3838

39+
Check out our setup [requirements](https://nuxt.studio/docs/projects/setup#requirements-to-use-the-studio-editor).
40+
3941
By default the Studio API is `https://api.nuxt.studio`. If you want to customise it, you can set the `STUDIO_API` environement variable.
4042

4143
```bash
4244
# .env
43-
STUDIO_API=https://dev-api.nuxt.studio
45+
STUDIO_API=http://localhost:{PORT}
4446
```
4547

4648
### Development
4749

4850
- Run `yarn install` to install dependencies.
4951
- Run `yarn dev` to start the dev server using [`playground/`](./playground/) as the project.
50-
- Visit http://localhost:3100/
52+
- Visit http://localhost:3000/
5153

5254
## License
5355

0 commit comments

Comments
 (0)