From dd2c238a1e2b8823dac42789bed7e119915d9bd4 Mon Sep 17 00:00:00 2001
From: Sorin Sbarnea <ssbarnea@redhat.com>
Date: Tue, 6 Feb 2024 13:15:29 +0000
Subject: [PATCH] Add config example

---
 .pre-commit-config.yaml |  1 -
 README.md               | 37 +++++++++++++++++++++++--------------
 2 files changed, 23 insertions(+), 15 deletions(-)

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 60b314e..aeda993 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -10,7 +10,6 @@ ci:
   skip:
     # https://github.com/pre-commit-ci/issues/issues/55
     - pip-compile
-    - schemas
   submodules: true
 exclude: >
   (?x)^(
diff --git a/README.md b/README.md
index 6f3aa0a..c593d39 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,35 @@
 # gh-pre
 
 An experimental tool that helps with Project Release Engineering, focused on
-repository clusters (groups of repositories which need to be released in
+repository clusters (groups of repositories that need to be released in
 particular order).
 
 ```shell
 gh extension install pycontribs/gh-pre
 ```
 
-Usage:
+## Configuration
+
+To use the tool you need to configure the list of repositories it needs to check on each run:
+
+```yaml
+# ~/pre.yml
+repos:
+  - ansible/ansible-compat
+  - ansible/ansible-lint
+  - ansible/ansible-navigator
+  - ansible/ansible-creator
+  - ansible/molecule
+  - ansible/tox-ansible
+  - ansible/pytest-ansible
+  - ansible/ansible-development-environment
+  - ansible/ansible-dev-tools
+  - ansible/creator-ee
+```
+
+This will tell it which repositories to check for draft releases.
+
+## Usage
 
 ```shell
 gh pre
@@ -20,15 +41,3 @@ It can also be installed and executed as a Python package:
 pip install gh-pre
 pre
 ```
-
-## Configuration
-
-Please create a `~/pre.yml` config file with content similar to:
-
-```
-repos:
-    - github-org/project1
-    - github-org/project2
-```
-
-This will tell it which repositories to check for draft releases.