Skip to content

Commit 1c93e36

Browse files
halbowStranger6667
authored andcommitted
docs: Add installation step in README and correct title in CONTRIBUTING
1 parent 1797405 commit 1c93e36

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CONTRIBUTING.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ It would be awesome if you can submit a failing test that demonstrates the probl
4242
.. _fixbugs:
4343

4444
Submitting Pull Requests
45-
-----------------------
45+
------------------------
4646

4747
#. Fork the repository.
4848
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,18 @@ Features
1313
- Network access blocking;
1414
- The ``rewrite`` recording mode that rewrites cassettes from scratch.
1515

16+
Installation
17+
------------
18+
19+
This project can be installed via pip:
20+
21+
.. code:: bash
22+
23+
pip install pytest-recording
24+
25+
⚠️This project is not compatible with `pytest-vcr`, make sure to uninstall before ⚠️
26+
27+
1628
Usage
1729
-----
1830

0 commit comments

Comments
 (0)