Skip to content

Commit bdb0896

Browse files
authored
feat: update readme
Signed-off-by: David Mortensen <156092822+lfvdavid@users.noreply.github.com>
1 parent ed2105b commit bdb0896

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,23 @@ The plugin can be configured through the `pyproject.toml` file. Configure plugin
3333

3434
```toml
3535
[tool.hatch.build.hooks.reqstool]
36-
dependencies = ["reqstool-python-hatch-plugin == <version>"]
3736
sources = ["src", "tests"]
37+
test_results = "build/**/junit.xml"
3838
dataset_directory = "docs/reqstool"
3939
output_directory = "build/reqstool"
40-
test_results = ["build/**/junit.xml"]
4140
```
4241

42+
And under `requires` in `[build-system]´ you need to add the plugin with the version, see example:
43+
44+
```toml
45+
[build-system]
46+
requires = [
47+
"hatchling",
48+
"reqstool-python-hatch-plugin==<version>",
49+
]
50+
```
51+
52+
4353
It specifies that the reqstool-python-hatch-plugin is a dependency for the build process, and it should be of a specific version.
4454

4555
Further it defines the paths where the plugin should be applied. In this case, it specifies that the plugin should be applied to files in the src and tests directories.

0 commit comments

Comments
 (0)