From dc1cc6fc24272a88a7a59394b6f3499ae19726de Mon Sep 17 00:00:00 2001
From: 0xd9a <0xd9a@noreply.codeberg.org>
Date: Wed, 15 May 2024 12:40:52 +0530
Subject: [PATCH] Update README.md

---
 README.md | 74 +++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 50 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 81c2520..d6dd955 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,60 @@
 **If you want to contribute to a _translation_:**[![Crowdin](https://badges.crowdin.net/fediplan/localized.svg)](https://crowdin.com/project/fediplan)
 
-### How to install FediPlan
+## How to install FediPlan
 
-**1 - Clone the repository**
+There are 2 methods to run Fediplan
+1. Build and run Docker image
+2. Manual install
 
-**2 - Install vendors:**
+### 1. Build and run Docker image
 
+#### Required programs
+- `git`
+- `docker`
+
+#### Steps
+
+1. Clone this repo<br>
+`git clone https://framagit.org/tom79/fediplan.git fediplan`
+
+2. Build the Docker image<br>
+`docker build -t fediplan fediplan`
+
+3. Run the docker image<br>
+`docker run fediplan`
+
+4. Find the IP<br>
+
+    - Find 'CONTAINER ID' of fediplan's container<br>
+    `docker ps | grep fediplan`
+
+    - Find IP address of the container<br>
+    `docker inspect <CONTAINER ID> | grep IPAddress`
+
+5. Open _<ip_address>:8080_ in your web browser
+
+### 2. Manual install
+
+#### Required programs
+- `git`
+- `php 8.3` and some extensions
+- `composer` ([getcomposer.org/download](https://getcomposer.org/download/))
+
+#### Steps
+
+1. Clone this repo<br>
+`git clone https://framagit.org/tom79/fediplan.git fediplan`
+
+2. Change directory to the cloned repo<br>
+`cd fediplan`
+
+3. Install vendors<br>
 `composer install -o`
 
-PS: You need to install `composer`, just use:
+4. Point your server software to '_public_' folder
 
-`apt install composer`
+### Support My work
+[fedilab.app/page/donations](https://fedilab.app/page/donations/)
 
-Or you can do that with the following commands:
-
-```
-php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
-php -r "if (hash_file('sha384', 'composer-setup.php') === '48e3236262b34d30969dca3c37281b3b4bbe3221bda826ac6a9a62d6444cdb0dcd0615698a5cbe587c3f0fe57a54d8f5') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
-php composer-setup.php
-php -r "unlink('composer-setup.php');"
-```
-
-See: [Download Composer](https://getcomposer.org/download/)
-
-**3 - Public directory:**
-
-Your site needs to target /path/to/FediPlan/public
-
-
-#### Support My work at [fedilab.app](https://fedilab.app/page/donations/)
-
-#### Credits
+### Credits
 Docker configurations are based on [github.com/TrafeX/docker-php-nginx](https://github.com/TrafeX/docker-php-nginx)