Update README.md

README.md

@@ -1,3 +1,75 @@
 # Plugin Facturation pour Garradin
 
-Plugin de facturation pour le logiciel de gestion d'association Garradin ( https://garradin.eu/  ).
+Plugin de facturation pour le logiciel de gestion d'association Garradin ( https://garradin.eu/ - https://fossil.kd2.org/garradin ).
+
+## Installation:
+Normalement, les plugins de Garradin doivent seulement être laissé sous forme d'archive .tar.gz dans le dossier plugins, or pour la génération des PDF, la librairie mPDF a besoin d'écrire des fichiers temporaires.
+Il faut pour cela faire :
+
+    mkdir facturation/
+    tar xvf facturation-0.1.0.tar.gz -C facturation/
+    rm facturation-0.1.0.tar.gz
+    chown -R www-data:www-data facturation/
+    chmod -R g+w facturation/ 
+
+
+Supprimer l'archive permet à Garradin de ne pas la lire à la place du dossier.
+
+
+## Fonctionnalités :
+- Créer et gérer une base de clients
+- Créer et modifier des factures et devis adressées aux membres de l'association ou des clients ajoutés
+- Génération des documents (facture et devis) en PDF grâce à la librairie mPDF
+- Liste les documents associés sur la fiche d'un client
+- Permet de définir le statut du document sur reglée
+- **Configuration** :
+    - Possibilité d'ajouter le numéro de SIRET de l'association si elle en possède un (apparait alors sur les documents)
+    - Modification du pied de page des documents (notament pour y inscrire des mentions légales)
+    - Vérifier le code postal : si coché, lors d'ajout ou de modification de client, le plugin vérifiera que le code postal entré est bien formaté (par rapport aux codes postaux français seulement)
+    - Noms de clients uniques : si coché, lors d'ajout ou de modicifation de client, le nom du client ne pourra pas être le même que celui d'un client déjà existant
+
+## Futur :
+- Ajout des champs Référence, Prix unitaire, Quantité sur les documents 
+- Actions sur liste de clients (exporter, supprimer)
+- Afficher/filtrer les documents par statuts réglé/archivé
+- Changer statut depuis la liste des documents
+- Système de template ou jsp pour modifier facilement l'apparence de la facture par l'utilisateur ?
+- Petite modif/fix CSS
+- Gestion TVA ?
+- Un devis ne devrait pas pouvoir être réglé
+- Quid si un membre de l'asso est supprimé alors que des documents lui sont adressées ?
+
+## Futur improbable :
+- Opérations de paiements dans la compta liés à une facture
+- Gestion de produits
+
+
+
+## Inclus les bibliothèques suivantes :
+
+- Composer :
+    https://getcomposer.org/
+    Copyright (c) Nils Adermann, Jordi Boggiano,
+    Licence: MIT
+
+- mPDF :
+    https://mpdf.github.io/
+    Copyright (C) 2010 Ian Back,
+    Licence : GNU GPL v2
+
+Et les dépendances de mPDF :
+
+- DeepCopy :
+    https://travis-ci.org/myclabs/DeepCopy
+    Copyright (c) 2013 My C-Sens,
+    Licence: MIT
+
+- random_compat :
+    https://github.com/paragonie/random_compat
+    Copyright (c) 2015 Paragon Initiative Enterprises,
+    Licence: MIT
+
+- fpdi :
+    https://www.setasign.com/products/fpdi/
+    Copyright (c) 2017 Setasign - Jan Slabon, https://www.setasign.com ,
+    Licence: MIT