From 9ef990de151a96520646bf7eb309fb090dae0bf6 Mon Sep 17 00:00:00 2001
From: Benoit Moreau <benoit@virtit.fr>
Date: Tue, 21 Nov 2017 22:37:26 +0100
Subject: [PATCH] commit initial du README

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3f3f98e..a1022a9 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
 # script-gammu_receive_sms
+## Information
 
-Script lors de la réception de SMS via gammu-smsd avec OTP
\ No newline at end of file
+Ce script permet d'executer une action par l'envoie d'un SMS par une personne de confiance. Il n'est pas fait pour fonctionner "clé en main", a vous de le modifier
+
+Elle est définie comme t'elle si :
+* Si il a le numéro de téléphone correcte
+* Si il a le bon OTP
+
+Le choix du OTP est surtout du fait qu'il est relativement simple de SPOOF un numéro de téléphone.
+
+Il necessite le packet **oathtool** pour fonctionner.
+
+## Configuration
+
+Il faut juste remplir les arguments suivant:
+* SECRETKEY='' en BASE32
+* PHONENUM='' avec l'attribut du pays (+33 pour la France)
+
+Pour que la fonction "cmd" fonctionne, il faut qu'il y ai la clé publique du compte root sur la machine distante.
+ 
+Pour que le script soit appelé par gammu à chaque SMS reçu, il faut rajouter l'option suivante dans **/etc/gammu-smsdrc** :
+
+```
+RunOnReceive = /opt/gammu_receive_sms.sh
+```
\ No newline at end of file