From 53360f2abb40e632debd34604769f0e8caee024a Mon Sep 17 00:00:00 2001
From: Antoine Le Gonidec <vv221@dotslashplay.it>
Date: Mon, 22 Jul 2024 12:17:01 +0200
Subject: [PATCH] [ReadMe] Add install instructions

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b895661
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# Millions Missing France - Freescout Customers Groups
+
+## Description
+
+This module adds the ability to create groups of customers, that can then be selected when starting a new conversation.
+A groups is a list of customers, and selecting it when starting a conversation adds the e-mail addresses of all these customers to the "CC:" list of the sent e-mail.
+
+## Installation instructions
+
+### Install the module
+
+#### Install from the archive
+
+Download the [release tarball] and extract its content into `Modules/MMFCustomersGroups`.
+
+[release tarball]: https://port.numenaute.org/MMF/freescrout-customers-groups/archive/0.2.0.tar.gz
+
+```
+wget https://port.numenaute.org/MMF/freescrout-customers-groups/archive/0.2.0.tar.gz -O freescrout-customers-groups-0.2.0.tar.gz
+tar xf freescrout-customers-groups-0.2.0.tar.gz -C Modules
+mv Modules/freescrout-customers-groups Modules/MMFCustomersGroups
+```
+
+#### Install from git
+
+```
+git clone https://port.numenaute.org/MMF/freescrout-customers-groups.git Modules/MMFCustomersGroups
+```
+
+### Update the database schema
+
+```
+php artisan migrate
+```