@nuxt/modules 0.5.0 → 0.6.0-d622fc

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

package/README.md

@@ -1,25 +1,101 @@
+[![Explore Nuxt Modules to build Vue applications](https://user-images.githubusercontent.com/904724/210602531-624c6b8b-3add-4e5e-b3f4-d981e4f2d775.jpg)](https://nuxt.com/modules)
+
 # 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)
+[![npm version][npm-version-src]][npm-version-href]
+[![Volta][volta-src]][volta-href]
+
+> Discover the Nuxt modules to add any CMS, Database, UI, Auth and integrations into your Vue application.
+
+- 🔗 [Modules listing](https://nuxt.com/modules)
+- 📖 [Module author guide](https://nuxt.com/docs/guide/going-further/modules)
+
+## Modules Database
+
+Metadata 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.
+
+### Add/Update a module
 
-## Contribution
+```bash
+pnpm sync <name> <repo>
+```
+
+Example: `pnpm sync tailwindcss nuxt-modules/tailwindcss`
+
+To sync with a branch different than `main`, suffix the repo with `#repo-branch`, example: `pnpm sync tailwindcss nuxt-modules/tailwindcss#dev`
+
+### 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 PR
+- If some data is outdated please directly open a pull request
+
+### Using CDN
+
+Compiled JSON data is available from following CDNs:
+
+- **jsdelivr:** https://cdn.jsdelivr.net/npm/@nuxt/modules@latest/modules.json
+- **unpkg:** https://unpkg.com/@nuxt/modules@latest/modules.json
 
-### Add/Update repository
+### Using npm package
 
-`yarn sync <owner>/<name>`
+You can use the `@nuxt/modules` package by installing it in your project:
+
+```bash
+# npm
+npm install @nuxt/modules
+
+# pnpm
+pnpm 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        | Canonical name or integration name
+`description`   | Yes       | 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 [./website/public/icons](./website/public/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 [./lib/categories.ts](./lib/categories.ts)
+`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. `nuxt` field specifies semver of supported nuxt version. `requires.bridge: true\|optional` can be used to specify Nuxt 2 bridge compatibility.
+
+
+## Maintenance
 
 ### Auto update all current modules
 
-`yarn  sync`
+```bash
+pnpm sync
+```
 
-### Generate `dist/module.json`
+### Generate `modules.json`
 
-`yarn build`
+```bash
+pnpm build
+```
 
 ## License
 
-MIT
+[MIT](./LICENSE) - Made by Nuxt Team
+
+[npm-version-src]: https://img.shields.io/npm/v/@nuxt/modules/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@nuxt/modules
+
+[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
+[volta-href]: https://volta.net/nuxt/modules?utm_source=readme_nuxt_modules