From 59bd6abfc3faca2f99ba076c974bd20f4dbfedec Mon Sep 17 00:00:00 2001
From: Elliot DeNolf <denolfe@gmail.com>
Date: Sat, 7 Oct 2023 11:24:26 -0400
Subject: [PATCH] chore: stub out basic READMEs for all packages

---
 packages/bundler-vite/README.md     | 28 ++++++++++++++++++++++++++++
 packages/bundler-webpack/README.md  | 28 ++++++++++++++++++++++++++++
 packages/db-mongodb/README.md       | 28 ++++++++++++++++++++++++++++
 packages/db-postgres/README.md      | 28 ++++++++++++++++++++++++++++
 packages/richtext-lexical/README.md | 28 ++++++++++++++++++++++++++++
 packages/richtext-slate/README.md   | 28 ++++++++++++++++++++++++++++
 6 files changed, 168 insertions(+)
 create mode 100644 packages/bundler-vite/README.md
 create mode 100644 packages/bundler-webpack/README.md
 create mode 100644 packages/db-mongodb/README.md
 create mode 100644 packages/db-postgres/README.md
 create mode 100644 packages/richtext-lexical/README.md
 create mode 100644 packages/richtext-slate/README.md

diff --git a/packages/bundler-vite/README.md b/packages/bundler-vite/README.md
new file mode 100644
index 000000000..e33bc1c93
--- /dev/null
+++ b/packages/bundler-vite/README.md
@@ -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).
+
diff --git a/packages/bundler-webpack/README.md b/packages/bundler-webpack/README.md
new file mode 100644
index 000000000..b7c9bc7c1
--- /dev/null
+++ b/packages/bundler-webpack/README.md
@@ -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).
+
diff --git a/packages/db-mongodb/README.md b/packages/db-mongodb/README.md
new file mode 100644
index 000000000..fcde1fead
--- /dev/null
+++ b/packages/db-mongodb/README.md
@@ -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).
+
diff --git a/packages/db-postgres/README.md b/packages/db-postgres/README.md
new file mode 100644
index 000000000..31dfe66bf
--- /dev/null
+++ b/packages/db-postgres/README.md
@@ -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).
+
diff --git a/packages/richtext-lexical/README.md b/packages/richtext-lexical/README.md
new file mode 100644
index 000000000..94eb44718
--- /dev/null
+++ b/packages/richtext-lexical/README.md
@@ -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).
+
diff --git a/packages/richtext-slate/README.md b/packages/richtext-slate/README.md
new file mode 100644
index 000000000..64534528b
--- /dev/null
+++ b/packages/richtext-slate/README.md
@@ -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).
+