Update README.md

README.md

@@ -12,28 +12,9 @@ app_port: 7860
 Certainly! Here's the content for your README.md file in markdown format:
 
 ```markdown
-# Eren Bot
+# ArtickBot
 
-Eren Bot is an AI chatbot built using FastAPI and Hugging Face's transformers library. It allows users to initiate conversations with the bot and receive responses based on predefined persona templates.
-
-## Requirements
-- Python 3.x
-- FastAPI
-- Hugging Face Transformers
-
-## Installation
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/your_username/eren-bot.git
-   ```
-2. Navigate to the project directory:
-   ```bash
-   cd eren-bot
-   ```
-3. Install dependencies:
-   ```bash
-   pip install -r requirements.txt
-   ```
+     - AI chatbot built using FastAPI and Hugging Face's transformers library. It allows users to initiate conversations with the bot and receive responses based on predefined persona templates.
 
 ## Usage
 1. Run the FastAPI server:
@@ -46,21 +27,23 @@ Eren Bot is an AI chatbot built using FastAPI and Hugging Face's transformers li
    
 3. 
    - `/start_chat/`: Start a new chat thread by providing a prompt and a persona description prompt i.e
+       - Expects a POST Request with a JSON Body
+          
       ```json
-        {"prompt":"what food would you recommend",
-          "persona_prompt":"you are a very helpful ai assistant. you are going to be polite and answer a humanily."
-        }
+         {"prompt":"what food would you recommend",
+          "persona_prompt":"you are a very helpful ai assistant. you are going to be polite and answer a humanily."}
       ```
       - `This method returns {'thread_id': thread_id, 'response': response}
    
    - `/start_conversation/`: Start a new conversation thread by providing a prompt.
+      - Expects a POST Request with a JSON Body
       ```json
-        {"prompt":"what is the time"
-        }
+         {"prompt":"what is the time"}
       ```
       - `After the request is done, this function returns {'response': response}
       
    - `/get_response/{thread_id}`: Retrieve the response from an existing conversation thread using its thread ID.
+      - Expects a GET Request with the {thread id} of the conversation
      
       - `Returns the specific thread id of the conversation