Update README

README.md

@@ -2,9 +2,7 @@
 
 A Simple LLM app that demonstrates a Retrieval-Augmented Generation (RAG) model for question-answering using LangChain, ChromaDB, and OpenAI's language models.
 
-The app allows users to upload documents (PDFs or text files), and then ask questions related to the content of those documents.
-
-The RAG model retrieves relevant passages from the documents and generates an answer based on the retrieved context.
+The app allows users to upload documents (PDFs or text files), and then ask questions related to the content of those documents. The RAG model retrieves relevant passages from the documents and generates an answer based on the retrieved context.
 
 ---
 
@@ -12,21 +10,46 @@ The RAG model retrieves relevant passages from the documents and generates an an
 
 ---
 
-## Table of Contents
+## Features
 
--   [Installation](#installation)
--   [Usage](#usage)
--   [Contributing](#contributing)
--   [License](#license)
+-   **Document Upload**: Supports uploading PDF and text files.
+-   **Question Answering**: Ask questions related to the uploaded documents.
+-   **Retrieval-Augmented Generation (RAG)**: Utilizes a RAG model for context-aware question answering.
+-   **LangChain Integration**: Leverages LangChain for building the RAG model.
+-   **ChromaDB**: Efficient vector storage and retrieval using ChromaDB.
+-   **OpenAI Language Models**: Powered by OpenAI's language models for answer generation.
+-   **Streamlit UI**: Interactive and user-friendly web interface.
 
-# Usage
+## Installation
 
-Clone the repository:
+1. Clone the repository:
 
-```bash
+```shellscript
 git clone https://github.com/vinhnx/InkChatGPT.git
 ```
 
+2. Navigate to the project directory:
+
+```shellscript
+cd InkChatGPT
+```
+
+3. Create a new Python environment and activate it (e.g., using `venv` or `conda`).
+
+4. Install the required packages:
+
+```shellscript
+pip install streamlit langchain chromadb openai tiktoken pypdf
+```
+
+or, run
+
+```shellscript
+pip install -r requirements.txt
+```
+
+## Usage
+
 1. **Open VSCode and Create a New Python Environment**:
 
 -   Open Visual Studio Code.
@@ -44,30 +67,22 @@ git clone https://github.com/vinhnx/InkChatGPT.git
 
 -   From the File menu, choose "Open Folder" or "Open..." and navigate to the project folder containing the `app.py` file.
 
-4. **Install Required Packages**:
-
--   Open a new Terminal in VSCode by clicking "Terminal" > "New Terminal" or pressing `Ctrl+Shift+`" (Windows/Linux) or `Cmd+Shift+`" (macOS).
--   In the terminal, run the following command to install the required packages:
-    ```
-    pip install streamlit langchain chromadb openai tiktoken pypdf
-    ```
-
-5. **Configure the App**:
+4. **Configure the App**:
 
 -   Open the `app.py` file in the VSCode editor.
 -   Set your OpenAI API key by modifying the `OPENAI_API_KEY` variable.
 -   Optionally, you can change the `CHROMA_PERSIST_DIRECTORY` and `OPENAI_MODEL` variables according to your preferences.
 
-6. **Run the Streamlit App**:
+5. **Run the Streamlit App**:
 
 -   In the terminal, navigate to the project directory if you're not already there.
 -   Run the following command to start the Streamlit app:
-    ```
+    ```shellscript
     streamlit run app.py
     ```
 -   This will start the Streamlit app and provide you with a local URL to access the app in your web browser.
 
-7. **Use the App**:
+6. **Use the App**:
 
 -   Open the provided local URL in your web browser.
 -   You should see the InkChatGPT interface.
@@ -75,18 +90,18 @@ git clone https://github.com/vinhnx/InkChatGPT.git
 
 ## Contributing
 
-Contributions are welcome! If you'd like to improve the Medium Article Generator, please follow these steps:
+Contributions are welcome! If you'd like to improve the InkChatGPT, please follow these steps:
 
 1. Fork the repository
-1. Create a new branch `git checkout -b feature/my-feature`
-1. Commit your changes `git commit -am 'Add some feature'`
-1. Push to the branch `git push origin feature/my-feature`
-1. Create a new Pull Request
+2. Create a new branch: `git checkout -b feature/my-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin feature/my-feature`
+5. Create a new Pull Request
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the [MIT License](LICENSE).
 
 ## Contact
 
-I'm Vinh, [@vinhnx](https://x.com/vinhnx) on almost everywhere.
+I'm Vinh, [@vinhnx](https://x.com/vinhnx) on almost everywhere. Feel free to reach out with any questions or feedback!