From 0bb170a3202d1e91cbc57480d4572b014b435954 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul?= Date: Mon, 5 Aug 2024 18:42:29 +0200 Subject: [PATCH] Improve usage instrucations --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5b886b5..ce9ca3e 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,21 @@ Options: --help Show this message and exit. ``` +## Using from the command line -## Pre-commit +This project is distributed on PyPI. The recommended way to run it is with +[pipx](https://github.com/pypa/pipx), with a command like this: + +`pipx run odoo-sort-manifest-depends --local-addons-dir=odoo/addons --odoo-version=16.0` + +## Using with pre-commit + +This project may be used as a [pre-commit](https://pre-commit.com) hook, with an +entry like this in `.pre-commit-config.yml`. ```yaml - repo: https://github.com/acsone/odoo-sort-manifest-depends - rev: v1.1 + rev: v1.x # see the release page https://github.com/acsone/odoo-sort-manifest-depends/releases hooks: - id: odoo-sort-manifest-depends args: @@ -46,4 +55,5 @@ Options: ## License -`odoo-sort-manifest-depends` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. +`odoo-sort-manifest-depends` is distributed under the terms of the +[MIT](https://spdx.org/licenses/MIT.html) license.