From 4e08fcc69d8ab0be3b373bef40a68d567ae64f96 Mon Sep 17 00:00:00 2001
From: Jan Klattenhoff <jan@kjan.email>
Date: Wed, 9 Apr 2025 18:34:02 +0200
Subject: [PATCH] docs: update README with usage and validation rules

---
 README.md | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a198e3f..a2e4f87 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
 # pull-request-lint
 
-Lints the title of a pull request
\ No newline at end of file
+A GitHub/Gitea Action that lints pull request titles to ensure they follow the [Conventional Commits](https://www.conventionalcommits.org/) format.
+
+## Usage
+
+Add the following to your GitHub/Gitea workflow:
+
+```yaml
+name: Pull Request Lint
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: your-org/pull-request-lint@main
+```
+
+## Validation Rules
+
+The action enforces the following Conventional Commits rules for PR titles:
+
+- Format must be: `type(scope)!: description` (scope and breaking change marker `!` are optional)
+- Type and scope must be lowercase
+- Description must start with lowercase
+- Breaking change indicator and footer are mutually exclusive
+- Body must be separated from description by a blank line
+- Footer tokens must use hyphens instead of spaces (except for "BREAKING CHANGE")
+
+## License
+
+See [LICENSE](LICENSE) file for details.
\ No newline at end of file