docs: update readme

[atinux]

Following #15

This is the ideal Readme I would like to see personally.

Regarding the module to work, we simply have to use import MyModule from '../src/module'; in the nuxt.config.ts, see https://stackblitz.com/edit/github-upewbw?file=playground%2Fnuxt.config.ts (this is what I do personally when working on a module) or maybe adding a "postinstall" script?

Open to suggestions 😊

See rendered version

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
nuxt3-starter	✅ Ready (Inspect)	Visit Preview	Apr 27, 2022 at 11:32AM (UTC)

[pi0]

Regarding the module to work, we simply have to use import MyModule from '../src/module'; in the nuxt.config.ts, see https://stackblitz.com/edit/github-upewbw?file=playground%2Fnuxt.config.ts (this is what I do personally when working on a module)

I would use src too but using main subpath has few benefits that makes types closer to what users expect and also allowing to test built module without changing playground...

[atinux]

What about adding a postinstall script?

[pi0]

postinstall also happens when users of a nuxt module install the package. We probably don't want that for a normal module! (https://docs.npmjs.com/cli/v8/using-npm/scripts#npm-install). Shall we only provide online version for app starters for now?

[atinux]

Make sense to not show the online playground for module creation for now

[pi0]

v2 branch is restored too.

[atinux]

From what I see, the v2-stackblitz should be renamed to v2, it uses the <Tutorial> example and is working fine on both StackBlitz and CSB:

• https://codesandbox.io/s/github/nuxt/starter/tree/v2-stackblitz
• https://stackblitz.com/github/nuxt/starter/tree/v2-stackblitz

[pi0]

I'm not sure how long we are going to keep v2 and v2-bridge but for same reason of v3-[platform], we can duplicate v2 to give platforms a permanent link keeping in their showcases.

[atinux]

Indeed, but v2 seems outdated, happy to duplicate v2-stackblitz to v2 and v2-codesandbox (+ add the sandbox.config.json)

[atinux]

Happy of this changes so far, I let you double check @pi0 😊