Update README.md

README.md

@@ -1,2 +1,86 @@
-# gptfree-jailbreak-webui
- 
+# GPTfree Jailbreak WebUI :unlock:
+  
+This repository contains ChatGPT unlocked with WebUI that *DOES NOT REQUIRE ANY API KEY*.  
+
+## Incorporated Projects :busts_in_silhouette:
+I highly recommend visiting and supporting both projects.
+
+### WebUI
+The application interface was incorporated from the [chatgpt-clone](https://github.com/xtekky/chatgpt-clone) repository.
+
+### API freeGPT
+The free GPT API was incorporated from the [freeGPT](https://github.com/Ruu3f/freeGPT) repository.
+
+## Table of Contents  
+- [Getting Started](#getting-started-white_check_mark)  
+  - [Cloning the Repository](#cloning-the-repository-inbox_tray)  
+  - [Install Dependencies](#install-dependencies-wrench)  
+- [Running the Application](#running-the-application-rocket)  
+- [Docker](#docker-)  
+  - [Prerequisites](#prerequisites)  
+  - [Running the Docker](#running-the-docker)  
+
+  
+## Getting Started :white_check_mark:  
+To get started with this project, you'll need to clone the repository and have [Python](https://www.python.org/downloads/) installed on your system.  
+  
+### Cloning the Repository :inbox_tray:
+Run the following command to clone the repository:  
+
+```
+git clone https://github.com/ramonvc/gptfree-jailbreak-webui.git
+```
+
+### Install Dependencies :wrench: 
+Navigate to the project directory:
+```
+cd gptfree-jailbreak-webui
+```
+
+Install the dependencies:
+```
+pip install -r requirements.txt
+```
+## Running the Application :rocket:
+To run the application, run the following command:
+```
+python run.py
+```
+
+Access the application in your browser using the URL:
+```
+http://127.0.0.1:1338
+```
+or
+```
+http://172.17.0.2:1338
+```
+
+## Docker 🐳
+### Prerequisites
+Before you start, make sure you have installed [Docker](https://www.docker.com/get-started) on your machine.
+
+### Running the Docker
+Build the Docker image:
+```
+docker-compose build
+```
+
+Run the application using Docker Compose:
+```
+docker-compose up
+```
+
+Access the application in your browser using the URL:
+```
+http://127.0.0.1:1338
+```
+or
+```
+http://172.17.0.2:1338
+```
+
+When you're done using the application, stop the Docker containers using the following command:
+```
+docker-compose down
+```