docs: Add installastion step in README and correct title in CONTRIBUTING

kiwicom · May 23, 2024 · 9b89047 · 9b89047
1 parent f4a26b2
commit 9b89047
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git 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 <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.

diff --git 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
 -----