From 9b89047d2757fbcf54bb88d6971f9e9e9cfaa71f Mon Sep 17 00:00:00 2001 From: Alexis Huberlant Date: Thu, 23 May 2024 14:51:18 +0200 Subject: [PATCH] docs: Add installastion step in README and correct title in CONTRIBUTING --- CONTRIBUTING.rst | 2 +- README.rst | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 57f874b..2448574 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -42,7 +42,7 @@ It would be awesome if you can submit a failing test that demonstrates the probl .. _fixbugs: Submitting Pull Requests ------------------------ +------------------------ #. Fork the repository. #. Enable and install `pre-commit `_ to ensure style-guides and code checks are followed. diff --git a/README.rst b/README.rst index 483ec6e..85f0000 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,18 @@ Features - Network access blocking; - The ``rewrite`` recording mode that rewrites cassettes from scratch. +Installation +------------ + +This project can be installed via pip: + +.. code:: bash + + pip install pytest-recording + +⚠️This project is not compatible with `pytest-vcr`, make sure to uninstall before ⚠️ + + Usage -----