Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jtgi authored Sep 17, 2024
1 parent c1642c0 commit 7d8970e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ Automod favors less directories, less files and generally avoids DRYing things u

See the [Prisma Schema](./prisma/schema.prisma) for an overview.

Point of note:
- **ModeratedChannel inclusionRuleSet and exclusionRuleSet:** These are json strings that define the moderation rules. See the zod schema in [validation.server.ts](/app/lib/validation.server.ts) for its shape. You may wonder why the shape isn't simpler. Automod supports recursive logical expressions of rules as well as multiple actions to execute but the UI at time of writing only exposes a single AND/OR and no preset actions. Even this customers get stuck on quite often.
- **RuleSets:** deprecated in favor of `inclusionRuleSet` and `exclusionRuleSet`.

### Key Flows

**How a cast is moderated**
Expand Down

0 comments on commit 7d8970e

Please sign in to comment.