Create README.md

README.md

@@ -0,0 +1,33 @@
+# Poetry Test Coverage Example
+
+This repo contains the sample code for the article - [How To Measure And Improve Test Coverage With Poetry And Pytest](https://pytest-with-eric.com/coverage/poetry-test-coverage/)
+
+
+## Requirements
+* Python (3.12)
+
+## Installation
+
+To install the project, you need to have Poetry installed. If you don't have it installed, you can install it by following the instructions [here](https://python-poetry.org/docs/#installation).
+
+## Usage
+
+To run the tests, you can use the following command:
+
+```bash
+poetry run pytest
+```
+
+To run the tests with coverage, you can use the following command:
+
+```bash
+$ poetry run coverage run -m pytest
+```
+
+To generate the coverage report, you can use the following command:
+
+```bash
+$ poetry run coverage report
+```
+
+If you have any questions about the project please raise an Issue on GitHub.