Skip to content

fix(NOSS-1): readme update (#37) #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ConnysCode merged 1 commit into from
Oct 2, 2025
Merged

fix(NOSS-1): readme update (#37) #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 23 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,9 @@
<img alt="Assist for Payload" src="https://raw.githubusercontent.com/byte5digital/payload-assist/master/.github/assets/gh-banner-light.png">
</picture>
<div align="center" style="display: flex; flex-direction: row; justify-content: center; align-items: center; gap: 12px;">
<a href="https://www.npmjs.com/@byte5digital/payload-assist">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="Assist for Payload" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
</a>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="Tests passing" src="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=ffffff&color=373E45">
<source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
<img alt="License MIT" src="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB">
</picture>
<a href="https://www.npmjs.com/@byte5digital/payload-assist"><picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=ffffff&color=373E45"><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB"><img alt="Assist for Payload" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fregistry.npmjs.org%2F@byte5digital%2Fpayload-assist&query=%24%5B%22dist-tags%22%5D.latest&prefix=v&label=NPM&style=for-the-badge&labelColor=002634&color=E5E9EB"></picture></a>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=ffffff&color=373E45"><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB"><img alt="Tests passing" src="https://img.shields.io/badge/TESTS-PASSING-empty?style=for-the-badge&labelColor=002634&color=E5E9EB"></picture>
<picture><source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=ffffff&color=373E45"><source media="(prefers-color-scheme: light)" srcset="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB"><img alt="License MIT" src="https://img.shields.io/badge/LICENSE-MIT-empty?style=for-the-badge&labelColor=002634&color=E5E9EB"></picture>
</div>

# Assist for Payload
Expand Down Expand Up @@ -91,18 +77,27 @@ payloadAssist is implemenented as a wrapper function and not as a payload plugin

```ts
import { buildConfig } from "payload";
import payloadAssist, { defaultConfig } from "@byte5digital/payload-assist";

export default payloadAssist({
// your Payload config
}, {
ruleSet: {
...defaultConfig.ruleSet,
import payloadAssist, {
defaultConfig,
PayloadAssistError,
} from "@byte5digital/payload-assist";

// add/override rules here
secretIsSet: (config) => config.secret?.length > 0 ? true : throw 'A secret needs to be set',
export default payloadAssist(
{
// your Payload config
},
});
{
ruleSet: {
...defaultConfig.ruleSet,

// add/override rules here
secretIsSet: (config) => {
if (config.secret?.length > 0) return true;
throw new PayloadAssistError("A secret needs to be set");
},
},
}
);
```

---
Expand Down Expand Up @@ -236,8 +231,7 @@ If you love building smart solutions with real impact — we should talk.

## Support

- [Issue Tracker](https://github.com/byte5digital/meilisearch-pro/issues)
- [Discord Community](https://discord.gg/medusajs)
- [Issue Tracker](https://github.com/byte5digital/payload-assist/issues)
- [Email Support](mailto:support@byte5.de)

---
Expand Down
2 changes: 2 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,5 @@ export { Expose, Type } from "class-transformer";
export type { PayloadAssistConfig, PayloadAssistOptions } from "./types/config";
export type { RuleSet } from "./types/rule-set";
export type { AccessControl } from "./types/access-control";

export { default as PayloadAssistError } from "./types/PayloadAssistError";