Update README.md

README.md

@@ -1,40 +1,37 @@
----
----
-overview:
-  description: >
-    This project is a Language Model (LLM) Summarizer that utilizes the
-    power of
+ # S I M P L I F Y
 
-    Hugging Face's Transformers library to generate summaries from given text content.
+**Harness the power of LLMs to extract concise summaries from extensive text.**
 
-    The application is designed to simplify the summarization process, making it easy
+## Installation
 
-    for users to generate concise summaries for large volumes of text.
-getting_started:
-  steps:
-    - create_virtual_environment: >
-        Create a virtual environment in Python using
-        [venv](https://docs.python.org/3/library/venv.html)
+1. **Create a virtual environment:**
+   - Navigate to the project directory in your terminal.
+   - Create a virtual environment: `python -m venv env`
+   - Activate the environment:
+     - Windows: `env\Scripts\activate.bat`
+     - Linux/macOS: `source env/bin/activate`
 
-        to manage project dependencies.
-    - install_dependencies: >
-        Run the following command to install the required packages
-        from the `requirements.txt` file:
+2. **Install dependencies:**
+   - Install required packages: `pip install -r requirements.txt`
 
-        ```bash
+3. **Set environment variable:**
+   - Set your Hugging Face API token:
+     `export HUGGINFACEHUB_API_TOKEN=YOUR_API_TOKEN`
+   - Set your Hugging Face API token as api_token variable.
 
-        pip install -r requirements.txt
+## Usage
 
-        ```
-    - set_huggingface_api_token: >
-        - Obtain your Hugging Face API token from [Hugging
-        Face](https://huggingface.co/).
+1. **Run the main script:**
+   - Execute the main script: `python main.py`
 
-        - Set the `HUGGINGFACEHUB_API_TOKEN` environment variable with your Hugging Face API key.
-          Also, ensure that the `api` variable in the code matches your key.
-    - run_application: |
-        Execute the main
+## Additional Information
 
----
+- **Key frameworks:** LangChain, Hugging Face LLMs
+- **Supported document types:** PDF (currently)
+- **Customization:** Adjust prompts and code for different content and queries.
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+## Creators
+- Anish De, B.Tech. Electrical Engineering
+- Yash Shrivastava, B.Tech. Computer Science Engineering
+- Dev Virani, B.Tech. Computer Science Engineering