From 23152a23b7bdeac69381714f4bbb581cef5a94b4 Mon Sep 17 00:00:00 2001 From: s-aga-r Date: Sun, 6 Oct 2024 13:08:32 +0530 Subject: [PATCH] chore: app installation docs (#15) --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4eb5f114..14e1d189 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,23 @@ Frappe Mail is an open-source email tool built on the [Frappe Framework](https:/ You can install this app using the [bench](https://github.com/frappe/bench) CLI: -```bash -cd $PATH_TO_YOUR_BENCH -bench get-app $URL_OF_THIS_REPO --branch develop -bench install-app mail -``` +1. Install Frappe Mail: + + ```bash + bench get-app mail + ``` + +2. Create a site with the mail app: + + ```bash + bench --site sitename.localhost install-app mail + ``` + +3. Open the site in the browser: + + ```bash + bench browse sitename.localhost --user Administrator + ``` ## Mail System Architecture