Skip to content

Commit

Permalink
chore: updates payload cloud plugin docs (#8943)
Browse files Browse the repository at this point in the history
Documentation updated to match current implementation.

Original Doc:
```ts
import { payloadCloud } from '@payloadcms/payload-cloud'
```

Current:
```ts
import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
```

---

References in docs have been updated.
  • Loading branch information
kendelljoseph authored Oct 30, 2024
1 parent f4041ce commit 61b4f2e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/payload-cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Add the plugin to your Payload config
`yarn add @payloadcms/payload-cloud`

```ts
import { payloadCloud } from '@payloadcms/payload-cloud'
import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
import { buildConfig } from 'payload'

export default buildConfig({
plugins: [payloadCloud()],
plugins: [payloadCloudPlugin()],
// rest of config
})
```
Expand All @@ -41,7 +41,7 @@ After configuring, ensure that the `from` email address is from a domain you hav
If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.

```ts
payloadCloud({
payloadCloudPlugin({
storage: false, // Disable file storage
email: false, // Disable email delivery
uploadCaching: false, // Disable upload caching
Expand All @@ -53,7 +53,7 @@ payloadCloud({
If you wish to configure upload caching on a per-collection basis, you can do so by passing in a keyed object of collection names. By default, all collections will be cached for 24 hours (86400 seconds). The cache is invalidated when an item is updated or deleted.

```ts
payloadCloud({
payloadCloudPlugin({
uploadCaching: {
maxAge: 604800, // Override default maxAge for all collections
collection1Slug: {
Expand Down

0 comments on commit 61b4f2e

Please sign in to comment.