Merge pull request #3 from habedi/hassan

Update the README files

README.md

@@ -1,25 +1,27 @@
 # Easy Letters
 
-[![Tests](https://github.com/habedi/easy-letters/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/easy-letters/actions/workflows/tests.yml)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![PyPI version](https://badge.fury.io/py/easy-letters.svg)](https://badge.fury.io/py/easy-letters)
-[![Downloads](https://pepy.tech/badge/easy-letters)](https://pepy.tech/project/easy-letters)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![python version](https://img.shields.io/badge/Python-%3E=3.10-blue)](https://github.com/habedi/easy-letters)
+[![pip downloads](https://img.shields.io/pypi/dm/easy-letters.svg)](https://pypi.org/project/easy-letters/)
+[![Tests](https://github.com/habedi/easy-letters/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/easy-letters/actions/workflows/tests.yml)
+[![CodeFactor](https://www.codefactor.io/repository/github/habedi/easy-letters/badge)](https://www.codefactor.io/repository/github/habedi/easy-letters)
 
 Easy Letters is a Python package that helps job seekers write application letters. A simple retrieval
 augmented generation (RAG) pipeline is used to generate the letters. The user can then edit the draft letter to suit
 their needs.
 
 See the `notebooks/README.md` file for how easy letters works.
 
-## Installation
+## 🔧 Installation
 
 You can install Easy Letters using pip:
 
 ```bash
 pip install easy-letters
 ```
 
-## Getting Started
+## 🚀 Getting Started
 
 ### API Key Setup
 
@@ -61,7 +63,15 @@ git clone https://github.com/habedi/easy-letters.git && cd easy-letters
 poetry install --with dev
 ```
 
-## TODO
+### Running the Unit Tests with Coverage
+
+You can run the unit tests with coverage using the following command:
+
+```bash
+poetry run pytest tests/ --cov=easy_letters
+```
+
+## 📝 TODO
 
 - [ ] Add support for Anthropic models and API
 - [ ] Add support for locally served models via Ollama

notebooks/README.md

@@ -1,4 +1,4 @@
-# Overview
+# 📝 Overview
 
 The diagram below shows the high-level workflow of how Easy Letters generates application letter drafts.