From 075b32bfc36d037015613ad2f5cfdc9fa83e00d3 Mon Sep 17 00:00:00 2001 From: Daniele Date: Mon, 20 Nov 2023 18:44:29 +0100 Subject: [PATCH] README: misc cleanup --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9275a65..9ae9764 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ ---- -title: pytest-fzf ---- +# pytest-fzf [![PyPI version](https://img.shields.io/pypi/v/pytest-fzf.svg)](https://pypi.org/project/pytest-fzf) [![Python versions](https://img.shields.io/pypi/pyversions/pytest-fzf.svg)](https://pypi.org/project/pytest-fzf) @@ -12,17 +10,16 @@ fzf-based test selection with `pytest` --- -# Features +## Features - Select tests to be run with pytest using fzf -# Requirements +## Requirements - [fzf](https://github.com/junegunn/fzf) -- (Optional, for colored preview of test functions) [`bat`](https://github.com/sharkdp/bat) - () +- (Optional, for colored preview of test functions) `bat`[sharkdp/bat](https://github.com/sharkdp/bat) -# Installation +## Installation You can install `pytest-fzf` via [pip](https://pypi.org/project/pip/) from [PyPI](https://pypi.org/project): @@ -31,7 +28,7 @@ from [PyPI](https://pypi.org/project): pip install pytest-fzf ``` -# Usage +## Usage ```bash pytest --fzf [query] @@ -46,19 +43,19 @@ Optionally, the initial query can be specified from the command line: pytest --fzf query ``` -# Contributing +## Contributing Contributions are very welcome. Tests can be run with [nox](https://github.com/wntrblm/nox), please ensure the coverage at least stays the same before you submit a pull request. -# License +## License Distributed under the terms of the [GNU GPL v3.0](http://www.gnu.org/licenses/gpl-3.0.txt) license, `pytest-fzf` is free and open source software -# Issues +## Issues If you encounter any problems, please [file an issue](https://github.com/dtrifiro/pytest-fzf/issues) along with a