Skip to content

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
larbish authored Oct 31, 2023
1 parent 8516f46 commit 6bdc9ce
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href] -->

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

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

📖  Official [Documentation](https://nuxt.studio/docs/projects/setup#requirements-to-use-the-studio-editor)

## Features

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

## Installation

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

## Configuration

Check out our setup [requirements](https://nuxt.studio/docs/projects/setup#requirements-to-use-the-studio-editor).

By default the Studio API is `https://api.nuxt.studio`. If you want to customise it, you can set the `STUDIO_API` environement variable.

```bash
# .env
STUDIO_API=https://dev-api.nuxt.studio
STUDIO_API=http://localhost:{PORT}
```

### Development

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

## License

Expand Down

0 comments on commit 6bdc9ce

Please sign in to comment.