chore: stub out basic READMEs for all packages
This commit is contained in:
28
packages/bundler-vite/README.md
Normal file
28
packages/bundler-vite/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Payload Vite Adapter
|
||||||
|
|
||||||
|
Official Vite adapter for [Payload](https://payloadcms.com).
|
||||||
|
|
||||||
|
- [Main Repository](https://github.com/payloadcms/payload)
|
||||||
|
- [Payload Docs](https://payloadcms.com/docs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @payloadcms/bundler-vite
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { buildConfig } from 'payload/config'
|
||||||
|
import { viteBundler } from '@payloadcms/bundler-vite'
|
||||||
|
|
||||||
|
export default buildConfig({
|
||||||
|
bundler: viteBundler(),
|
||||||
|
// ...rest of config
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
More detailed usage can be found in the [Payload Docs](https://payloadcms.com/docs/configuration/overview).
|
||||||
|
|
||||||
28
packages/bundler-webpack/README.md
Normal file
28
packages/bundler-webpack/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Payload Webpack Adapter
|
||||||
|
|
||||||
|
Official Webpack adapter for [Payload](https://payloadcms.com).
|
||||||
|
|
||||||
|
- [Main Repository](https://github.com/payloadcms/payload)
|
||||||
|
- [Payload Docs](https://payloadcms.com/docs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @payloadcms/bundler-webpack
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { buildConfig } from 'payload/config'
|
||||||
|
import { webpackBundler } from '@payloadcms/bundler-webpack'
|
||||||
|
|
||||||
|
export default buildConfig({
|
||||||
|
bundler: webpackBundler()
|
||||||
|
// ...rest of config
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
More detailed usage can be found in the [Payload Docs](https://payloadcms.com/docs/configuration/overview).
|
||||||
|
|
||||||
28
packages/db-mongodb/README.md
Normal file
28
packages/db-mongodb/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Payload MongoDB Adapter
|
||||||
|
|
||||||
|
Official MongoDB adapter for [Payload](https://payloadcms.com).
|
||||||
|
|
||||||
|
- [Main Repository](https://github.com/payloadcms/payload)
|
||||||
|
- [Payload Docs](https://payloadcms.com/docs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @payloadcms/db-mongodb
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { buildConfig } from 'payload/config'
|
||||||
|
import { mongooseAdapter } from '@payloadcms/db-mongodb'
|
||||||
|
|
||||||
|
export default buildConfig({
|
||||||
|
db: mongooseAdapter({}),
|
||||||
|
// ...rest of config
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
More detailed usage can be found in the [Payload Docs](https://payloadcms.com/docs/configuration/overview).
|
||||||
|
|
||||||
28
packages/db-postgres/README.md
Normal file
28
packages/db-postgres/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Payload Postgres Adapter
|
||||||
|
|
||||||
|
Official Postgres adapter for [Payload](https://payloadcms.com).
|
||||||
|
|
||||||
|
- [Main Repository](https://github.com/payloadcms/payload)
|
||||||
|
- [Payload Docs](https://payloadcms.com/docs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @payloadcms/db-postgres
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { buildConfig } from 'payload/config'
|
||||||
|
import { postgresAdapter } from '@payloadcms/db-postgres'
|
||||||
|
|
||||||
|
export default buildConfig({
|
||||||
|
db: postgresAdapter({}),
|
||||||
|
// ...rest of config
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
More detailed usage can be found in the [Payload Docs](https://payloadcms.com/docs/configuration/overview).
|
||||||
|
|
||||||
28
packages/richtext-lexical/README.md
Normal file
28
packages/richtext-lexical/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Payload Lexical Rich Text Editor
|
||||||
|
|
||||||
|
Lexical Rich Text Editor for [Payload](https://payloadcms.com).
|
||||||
|
|
||||||
|
- [Main Repository](https://github.com/payloadcms/payload)
|
||||||
|
- [Payload Docs](https://payloadcms.com/docs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @payloadcms/richtext-lexical
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { buildConfig } from 'payload/config'
|
||||||
|
import { lexicalEditor } from '@payloadcms/richtext-lexical'
|
||||||
|
|
||||||
|
export default buildConfig({
|
||||||
|
editor: lexicalEditor({})
|
||||||
|
// ...rest of config
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
More detailed usage can be found in the [Payload Docs](https://payloadcms.com/docs/configuration/overview).
|
||||||
|
|
||||||
28
packages/richtext-slate/README.md
Normal file
28
packages/richtext-slate/README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
# Payload Slate Rich Text Editor
|
||||||
|
|
||||||
|
Slate Rich Text Editor for [Payload](https://payloadcms.com).
|
||||||
|
|
||||||
|
- [Main Repository](https://github.com/payloadcms/payload)
|
||||||
|
- [Payload Docs](https://payloadcms.com/docs)
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @payloadcms/richtext-slate
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { buildConfig } from 'payload/config'
|
||||||
|
import { slateEditor } from '@payloadcms/richtext-slate'
|
||||||
|
|
||||||
|
export default buildConfig({
|
||||||
|
editor: slateEditor({})
|
||||||
|
// ...rest of config
|
||||||
|
})
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
More detailed usage can be found in the [Payload Docs](https://payloadcms.com/docs/configuration/overview).
|
||||||
|
|
||||||
Reference in New Issue
Block a user