From eba7575f7eccc9ee1aa5874769b44a62b612947d Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Tue, 6 Oct 2015 10:55:42 -0400 Subject: [PATCH] README: information about rules Signed-off-by: Vincent Batts --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b9db0c9..be2542c 100644 --- a/README.md +++ b/README.md @@ -83,3 +83,13 @@ vbatts@valse ~/src/vb/git-validation (master) $ git-validation vbatts@valse ~/src/vb/git-validation (master) $ echo $? 1 ``` + +## Rules + +Default rules are added by registering them to the `validate` package. +Usually by putting them in their own package. +See [`./rules/`](./rules/). +Feel free to contribute more. + +Otherwise, but using `validate` package API directly, rules can be handed directly to the `validate.Runner`. +