Skip to content

Commit e18f8c5

Browse files
authored
Merge pull request #3 from hasan-py/hasan-py-patch-1
Update README.md
2 parents 13da1be + 1b94eba commit e18f8c5

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,10 @@ To change the model used for inference, you can modify the `LLM` variable in the
5353
```
5454
chat-with-pdf/
5555
│── pdfs/ # Directory for uploaded PDFs
56-
│── app.py # Main Streamlit app
56+
│── pdf_rag.py # Main Streamlit app
5757
│── requirements.txt # Dependencies
5858
│── README.md # Documentation
59+
│── test_pdf_rag.py # Unit Test
5960
```
6061

6162
## Technologies Used
@@ -68,7 +69,11 @@ chat-with-pdf/
6869

6970
## Contributing
7071

71-
Feel free to submit issues and PRs to improve the project!
72+
Feel free to submit issues and PRs to improve the project! And follow this steps:
73+
74+
- Before submitting PRs, please update the corresponding test cases.
75+
- Please attach a screen recording video to the PR description showing that all functionality is working properly.
76+
7277

7378
## Acknowledgments
7479

0 commit comments

Comments
 (0)