From 0ec9926812bb0acce1d85a3a9bdafcffe093f31d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dar=C3=ADo=20Blanco?= <dblancoit@gmail.com>
Date: Mon, 23 May 2022 11:42:56 +0200
Subject: [PATCH] docs: explain rule configuration

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5812d10..6093aac 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,17 @@
 # @parcellab/danger-plugin
 
-Set of Danger rules used to check personal PRs.
-This repository serves as an example to set up company specific rules for PR checking.
+Set of Danger rules used to check PRs in JavaScript/TypeScript codebases.
+
+This plugin allows configuration for the following events:
+
+- Conventional commits format
+- Commit scopes (useful for monorepos)
+- PR title length
+- PR title scope (useful for monorepos)
+- PR relation to JIRA issue
+- Maximum number of commits in the PR
+- Maximum number of lines in the PR
+- Maximum number of changed files in the PR
 
 ## Usage