Skip to content

Commit f226ee7

Browse files
committed
feat(readme): update readme according to latest updates
1 parent 07ab7a3 commit f226ee7

1 file changed

Lines changed: 10 additions & 15 deletions

File tree

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ Integrate [Nuxt 3](https://nuxt.com) with [EdgeDB](https://www.edgedb.com) effor
1212
## Features
1313

1414
- 🍱 **Effortless Integration**: Set up a database with just one line of configuration.
15-
- 🧙 **Seamless Initialization**: Automates [EdgeDB CLI](https://www.edgedb.com/docs/cli/index) setup and [project initialization](https://www.edgedb.com/docs/cli/edgedb_project/edgedb_project_init).
1615
- 🎩 **Live Schema Updates**: Experience _HMR-like DX_ with watchers on **schema**, **queries**, and **migrations**.
1716
- 🛟 **Typed Query Generation**: Automatically generate a typed query client with [@edgedb/generate](https://www.edgedb.com/docs/clients/js/generation).
1817
- 🍩 **Integrated Database Management**: Pilot your database from [Nuxt DevTools](https://github.com/nuxt/devtools).
1918
- 🔐 **Flexible Auth**: 1-line toggle [Email](https://www.edgedb.com/docs/guides/auth/email_password) or [OAuth](https://www.edgedb.com/docs/guides/auth/oauth) authentication, with support for custom auth providers.
19+
- 🧙 **Initial guidance**: Guides you through [EdgeDB CLI](https://www.edgedb.com/docs/cli/index) setup and [project initialization](https://www.edgedb.com/docs/cli/edgedb_project/edgedb_project_init).
2020

2121
## Quick Setup
2222

@@ -36,6 +36,12 @@ export default defineNuxtConfig({
3636
})
3737
```
3838

39+
3. Run `npx nuxt-edgedb-module` in your project root to run the CLI setup wizard.
40+
41+
```bash
42+
npx nuxt-edgedb-module
43+
```
44+
3945
That's it! Your Nuxt project now have a database. ✨
4046

4147
If you do not already have [EdgeDB](https://www.edgedb.com) installed on your machine, the install wizard will help you install it.
@@ -53,6 +59,7 @@ pnpm install
5359
pnpm stub
5460
cd playground
5561
edgedb project init
62+
npx nuxt-edgedb-module
5663
pnpm run dev
5764
```
5865

@@ -72,22 +79,10 @@ export default defineNuxtConfig({
7279
watchPrompt: true,
7380
// Generate target for your queries and query builder
7481
generateTarget: 'ts',
75-
// dbschema/ dir (you should not touch this)
82+
// dbschema/ dir
7683
dbschemaDir: 'dbschema',
77-
// dbschema/ dir (you should not touch this)
84+
// Individual queries dir (useEdgeDbQueries composable)
7885
queriesDir: 'queries',
79-
// dbschema/ dir (you should not touch this)
80-
queryBuilderDir: 'dbschema/query-builder',
81-
// Toggles typings generation (#edgedb/interfaces)
82-
generateInterfaces: true,
83-
// Toggles typings generation (#edgedb/queries)
84-
generateQueries: true,
85-
// Toggles typings generation (#edgedb/builder)
86-
generateQueryBuilder: true,
87-
// Toggles logging messages on code generation
88-
generateQuiet: true,
89-
// Toggles project init wizard
90-
projectInit: true,
9186
// Toggle CLI install wizard
9287
installCli: true,
9388
// Toggles composables

0 commit comments

Comments
 (0)