Skip to content

Commit 4d6de1b

Browse files
author
Muhammad Ali
committed
improver readme
1 parent e451234 commit 4d6de1b

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ This Python script efficiently generates customized prompts using a template and
1010

1111
**Steps:**
1212

13-
1. **Clone or download the repository:** (Add instructions if the project is on GitHub or similar)
13+
1. **Clone or download the repository.**
1414
2. **Install dependencies:**
1515
```bash
1616
pip install -r requirements.txt
1717
```
1818

1919
## **Usage**
2020

21-
**1. Understand your files (Not Necessary Already Done.):**
21+
**1. Understand your files (Not necessary already done.):**
2222

2323
* **key-values.csv:**
2424
* Create a CSV file with columns representing the keys to be replaced in your template.
@@ -36,6 +36,8 @@ This Python script efficiently generates customized prompts using a template and
3636

3737
* **Optional:** Use `-d` to exclude titles and focus on city names in your prompts.
3838

39+
> This feature is currently not optimized.
40+
3941
## **Explanation**
4042

4143
* **CSV File ('key-values.csv')**
@@ -46,7 +48,7 @@ This Python script efficiently generates customized prompts using a template and
4648
Explore the Charm of, Paris, France
4749
A Journey Through, Tokyo, Japan
4850
```
49-
![keyvalue.csv Example](/assets/keyvalues.csv_example.png
51+
![keyvalue.csv Example](/assets/keyvalues.csv_example.png)
5052

5153

5254
* **Prompt Template ('prompt.txt')**

0 commit comments

Comments
 (0)