second commit

README.md

@@ -19,3 +19,36 @@ ReWriteCraft/
 │   └── InformaltoFormal/ # Folder with examples of text converted from informal to formal tone
 ```
 
+## Features
+* **Customizable Tone**: Choose between Formal or Informal tones for your rewritten text.
+* **Customizable Dialect**: Choose between American or British dialects.
+* **Easy-to-use Interface**: The app is built using Streamlit, making it interactive and simple.
+* **Quick Response**: Rewritten text is generated with the help of the LLama 3.1 model.
+
+## How to Use
+1. **Clone the Repository**: Clone this repository to your local machine or server:
+```
+git clone https://github.com/iSathyam31/ReWriteCraft.git
+cd ReWriteCraft
+```
+2. Create a `.env` file: In the root directory, create a `.env` file to store your LangChain API key:
+```
+LANGCHAIN_API_KEY=your_api_key_here
+```
+3. **Install Dependencies**: Install the required Python packages listed in the `requirements.txt`:
+```
+pip install -r requirements.txt
+```
+4. **Run the App**: Once the dependencies are installed, you can run the Streamlit app using:
+```
+streamlit run app.py
+```
+The app will be accessible in your browser at `http://localhost:8501`.
+
+## Project Constraints
+* **Word Limit**: The app currently supports a maximum of 1500 words for input. You can modify this limit in the code if needed. The input text must be within this word count to avoid performance issues.
+* **Tone & Dialect Selection**:
+  - The options for tone (Formal/Informal) and dialect (American/British) are optional. You can choose one or both options based on your needs.
+  - If you want a specific tone or dialect applied to your text, simply check the corresponding boxes. You can apply both tone and dialect together or choose either one independently.
+  This flexibility allows you to get a variety of outputs depending on your selection.  
+