From accb0b54ff866aabcfadc2d634b4cc98c4aea7f7 Mon Sep 17 00:00:00 2001 From: Hassan Abedi Date: Fri, 28 Jun 2024 13:47:10 +0200 Subject: [PATCH] WIP --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 6060d71..54e411f 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,9 @@ [![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) -Easy Letters is a Python package to help job seekers writing application letters. It uses a simple retrieval -augmented generation (RAG) pipeline to generate the letters. The user can then edit the draft letter to suit their +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. ## Installation @@ -42,23 +43,16 @@ Easy Letters currently supports the following models: | Text Embedding 3 (Small Variant) | Text Embedding | | Text Embedding 3 (Large Variant) | Text Embedding | -### Installation from Source +### Installing from Source -You can also install Easy Letters from the source code in this repository. -The main benefit of this approach is that you can use run the sample notebooks and modify the code as you wish. +You can also install Easy Letters from the source code in this repository. The main benefit of this approach is that +you might find it easier to run the sample notebooks and modify the code as you wish this way. -To you can follow the steps below: +After cloning this repository, you can navigate to the `easy-letters` directory and install the +dependencies using [Poetry](https://python-poetry.org/): ```bash -git clone https://github.com/habedi/easy-letters.git -``` - -Then, navigate to the `easy-letters` directory and install the dependencies using [Poetry](https://python-poetry.org/). - -```bash - -cd easy-letters && poetry install - +git clone https://github.com/habedi/easy-letters.git && cd easy-letters poetry install --with dev ```