Skip to content

Commit

Permalink
Improve usage instrucations
Browse files Browse the repository at this point in the history
  • Loading branch information
sbidoul committed Aug 5, 2024
1 parent 0c092f1 commit 0bb170a
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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.

0 comments on commit 0bb170a

Please sign in to comment.