From e5e46e8e6270ff47387efb4699940d6661e3217e Mon Sep 17 00:00:00 2001 From: Karishma Shukla Date: Sat, 14 Dec 2024 07:43:19 +0530 Subject: [PATCH] docs: clearer installation instructions --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 26eb72fe..c8441f1a 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,14 @@ Maxun lets you train a robot in 2 minutes and scrape the web on auto-pilot. Web # Installation +1. First, create a file named `.env` in the root folder of the project +2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). Copy all content of example env to your `.env` file. +3. Choose your installation method below + ### Docker Compose +1. Copy the `docker-compose.yml` file from the codebase +2. Ensure you have setup the `.env` file +3. Run the command below ``` docker-compose up -d ```