[ReadMe] Add install instructions

This commit is contained in:
Antoine Le Gonidec 2024-07-22 12:17:01 +02:00
parent 63097ea17e
commit 53360f2abb
Signed by: vv221
GPG key ID: 636B78F91CEB80D8

34
README.md Normal file
View file

@ -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
```