|
11 | 11 |
|
12 | 12 | ## Features |
13 | 13 |
|
14 | | -- 🍱 Zero-config setup; just add `nuxt-edgedb` to your `modules` |
| 14 | +- 🍱 Zero-config setup; just add `nuxt-edgedb-module` to your `modules` |
15 | 15 | - 🧙 [EdgeDB CLI install](https://www.edgedb.com/docs/cli/index) and [project init](https://www.edgedb.com/docs/cli/edgedb_project/edgedb_project_init) wizards |
16 | 16 | - 🎩 Watchers on `dbschema/*`, `queries/*`, `dbschema/migrations/*` bringing _HMR_ to your database |
17 | 17 | - 🛟 Auto-imported typed database query client provided by [`@edgedb/generate`](https://www.edgedb.com/docs/clients/js/generation) |
|
21 | 21 |
|
22 | 22 | ## Quick Setup |
23 | 23 |
|
24 | | -1. Add `nuxt-edgedb` dependency to your project |
| 24 | +1. Add `nuxt-edgedb-module` dependency to your project |
25 | 25 |
|
26 | 26 | ```bash |
27 | 27 | # Using pnpm |
28 | | -pnpm add -D nuxt-edgedb |
| 28 | +pnpm add -D nuxt-edgedb-module |
29 | 29 |
|
30 | 30 | # Using yarn |
31 | | -yarn add --dev nuxt-edgedb |
| 31 | +yarn add --dev nuxt-edgedb-module |
32 | 32 |
|
33 | 33 | # Using npm |
34 | | -npm install --save-dev nuxt-edgedb |
| 34 | +npm install --save-dev nuxt-edgedb-module |
35 | 35 | ``` |
36 | 36 |
|
37 | | -2. Add `nuxt-edgedb` to the `modules` section of `nuxt.config.ts` |
| 37 | +2. Add `nuxt-edgedb-module` to the `modules` section of `nuxt.config.ts` |
38 | 38 |
|
39 | 39 | ```js |
40 | 40 | export default defineNuxtConfig({ |
41 | 41 | modules: [ |
42 | | - 'nuxt-edgedb' |
| 42 | + 'nuxt-edgedb-module' |
43 | 43 | ], |
44 | 44 | // Optional, all options has sufficient defaults. |
45 | 45 | edgedb: { |
@@ -260,6 +260,14 @@ If you do not want any of these features, just set `watch` to false and you are |
260 | 260 |
|
261 | 261 | > HMR on your database obviously has **NO** effect in production context. |
262 | 262 |
|
| 263 | +### Why the name isn't `nuxt-edgedb` |
| 264 | + |
| 265 | +Because that handle is already taken on NPM. |
| 266 | + |
| 267 | +It seem to be taken by [`ohmree`](https://github.com/ohmree), but the package seem inactive. |
| 268 | + |
| 269 | +If anyone happens to know him, I would be happy to get in contact! |
| 270 | + |
263 | 271 | ## Development |
264 | 272 |
|
265 | 273 | ```bash |
|
0 commit comments