From a1c3f47e3c184665789d6ad4e357ed061fbec21c Mon Sep 17 00:00:00 2001
From: Simone Orsi <simahawk@gmail.com>
Date: Fri, 13 Sep 2024 07:44:28 +0200
Subject: [PATCH] Update README

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/README.md b/README.md
index 489d304..7b195d0 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,14 @@ Features:
 * create/update repositories
 * create/update teams and roles
 * create/update branches
+* add new branches to existing YAML conf
+
+
+## Available tools
+
+* ``oca-repo-manage`` used to automatically maintain repositories based on YAML conf (see OCA conf below)
+* ``oca-repo-pages`` used to automatically generate repo inventory docs from the same YAML conf
+* ``oca-repo-add-branch`` used to manually add new branches to existing conf
 
 ## I can use it on my own organization?
 
@@ -29,6 +37,36 @@ https://github.com/OCA/repo-maintainer-conf
 
 You can use the script `scripts/bootstrap_data.py` to generate the conf out of existing repos. Run it with `--help` to see the options.
 
+# Usage
+
+## Manage repos
+
+This action is normally performed via GH actions in the conf repo. You should not run it manually.
+
+Yet, here's the command:
+
+
+    oca-repo-manage --org $GITHUB_REPOSITORY_OWNER --token ${{secrets.GIT_PUSH_TOKEN}} --conf-dir ./conf
+
+## Generate docs
+
+This action is normally performed via GH actions in the conf repo. You should not run it manually.
+
+Yet, here's the command:
+
+    oca-repo-pages --org $GITHUB_REPOSITORY_OWNER --conf-dir conf --path docsource
+
+## Add new branches to all repos
+
+This action has to be performed manually when you need a new branch to be added to all repos in your conf.
+Eg: when a new Odoo version is released.
+
+Go to the conf repo on your file system and run this:
+
+    oca-repo-add-branch --conf-dir ./conf/ --branch 18.0
+
+Review, stage all the changes, commit and open a PR.
+
 ## Licenses
 
 This repository is licensed under [AGPL-3.0](LICENSE).