Skip to content

Commit

Permalink
Update README.md (#63)
Browse files Browse the repository at this point in the history
Update installation sections and copyright
  • Loading branch information
bjoernricks authored Jan 25, 2024
1 parent 03d0d5d commit d3c37d1
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,31 @@ formatting via [ruff](https://github.com/astral-sh/ruff).

### Install using pip

> [!NOTE] The `pip install` command does no longer work out-of-the-box in newer
> distributions like Ubuntu >= 23.04 because of [PEP 668](https://peps.python.org/pep-0668).
You can install the latest stable release of autohooks-plugin-ruff from the
Python Package Index using [pip](https://pip.pypa.io/):

pip install autohooks-plugin-ruff

Note the `pip` refers to the Python 3 package manager. In a environment where
Python 2 is also available the correct command may be `pip3`.
python3 -m pip install --user autohooks-plugin-ruff

### Install using poetry

It is highly encouraged to use [poetry](https://python-poetry.org) for
maintaining your project's dependencies. Normally autohooks-plugin-ruff is
installed as a development dependency.

poetry install
poetry add --group dev autohooks-plugin-ruff

## Usage

To activate the ruff autohooks plugin please add the following setting to your
To activate the ruff autohooks plugin please run

```shell
poetry run autohooks plugins add autohooks.plugins.ruff
```

or alternatively add the following setting to your
*pyproject.toml* file.

```toml
Expand Down Expand Up @@ -65,6 +71,6 @@ first.

## License

Copyright (C) 2023 [Greenbone AG](https://www.greenbone.net/)
Copyright (C) 2023 - 2024 [Greenbone AG](https://www.greenbone.net/)

Licensed under the [GNU General Public License v3.0 or later](LICENSE).

0 comments on commit d3c37d1

Please sign in to comment.