update readme

Author: pi0

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Nuxt.js Team
+Copyright (c) 2020 Nuxt Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,16 +1,69 @@
-[![nuxt/modules](https://modules.nuxtjs.org/preview.png)](https://modules.nuxtjs.org)
-
-> Official and community [Nuxt](https://nuxtjs.org) modules united on [modules.nuxtjs.org](https://modules.nuxtjs.org)
-
 # Nuxt Modules
 
 [![automated](https://flat.badgen.net/badge/publish/automated/green)](#)
 [![npm version](https://flat.badgen.net/npm/v/@nuxt/modules)](https://www.npmjs.com/package/@nuxt/modules)
 
-## Contributing
+> Discover Nuxt modules to supercharge your project! Created by the Nuxt team and community.
+
+👉 https://modules.nuxtjs.org
+
+## Modules Database
+
+Meta-data of nuxt modules are maintained in [yml](https://en.wikipedia.org/wiki/YAML) files inside [/modules](./modules) directory and automatically synced from upstream to fetch latest information.
+
+### Contribution
 
 - If you feel a module is missing, please create a new [issue](https://github.com/nuxt/modules/issues/new)
-- If some meta is wrong, feel free directly opening a pull request
+- If some data is outdated, directly opening a pull request
+
+### Using CDN
+
+Compiled JSON data is available from following CDNs:
+
+- **jsdelivr:**: https://cdn.jsdelivr.net/npm/@nuxt/modules/dist/modules.json
+- **unpkg:** https://unpkg.com/@nuxt/modules/dist/modules.json
+
+### Using npm package
+
+You can use the `@nuxt/modules` package by installing it in your project:
+
+```bash
+# npm
+npm install @nuxt/modules
+
+# yarn
+yarn add @nuxt/modules
+```
+
+Then you can directly import the list of modules:
+
+```js
+// ESM
+import modules from '@nuxt/modules'
+
+// CommonJS
+const modules = require('@nuxt/modules')
+```
+
+### Schema
+
+Field Name    | Auto sync | Description
+--------------|-----------|--------------
+name          | No        | Cannonical name of module
+description   | Yes       | Module short description
+repo          | No        | Github repository. Format is `org/name` or `org/name#main/path`
+npm           | Yes       | NPM package name
+icon          | No        | Icon of module from [/static/icons](./static/icons) directory
+github        | No        | Github URL
+website       | No        | Website URL
+learn_more    | No        | Link to learn more (website or relevant integration website)
+category      | No        | Module category from [/categories.json](./categories.json)
+type          | No        | `community` (for [nuxt-community](https://github.com/nuxt-community/)), `official` (for https://github.com/) or `3rd-party`
+maintainers   | Yes       | List of maintainers each item has `name`, `github` and `avatar`
+compatibility | No        | Module compatibility status. Valid keys are `2.x`, `2.x-bridge` and `3.x` and valid values are `working`, `wip`, `unknown`, `broken` and `rip`. Please see [this discussion](https://github.com/nuxt/framework/discussions/751) for more information.
+
+
+## Maintenance
 
 ### Add or update repository
 
@@ -30,62 +83,47 @@ yarn sync
 
 ### Generate `dist/module.json`
 
-```
+```sh
 yarn build
 ```
 
-## Module Usage
-
-You can use the `@nuxt/modules` package by installing it in your project:
-
-```bash
-npm install @nuxt/modules
-# Or yarn add @nuxt/modules
-```
-
-Then you can directly import the list of modules:
 
-```js
-const modules = require('@nuxt/modules')
-// modules is an array of objects
-// See https://unpkg.com/@nuxt/modules/dist/modules.json
-```
-
-## Website
+## Website development
 
-### Development
+- Clone repository
+- Install depenedencies using `npx yarn install`
 
-Start Nuxt in development:
+Start development:
 
 ```bash
-yarn dev
+npx yarn dev
 ```
 
-Then visit http://localhost:3000.
+Then visit http://localhost:3000
 
 In development, the npm downloads and GitHub stars will be mocked.
 
-### Production
+### Production build
 
 Create a [personnal GitHub token](https://github.com/settings/tokens) (no scope selected) and add it to `.env`:
 
-```bash
+```sh
 # .env
 GITHUB_TOKEN=<my-generated-github-token>
 ```
 
 Generate the website:
 
-```
+```sh
 yarn generate
 ```
 
 Start the production website:
 
-```bash
+```sh
 yarn start
 ```
 
 ## License
 
-MIT Nuxt.js Team
+[MIT](./LICENSE) - Made by Nuxt Team