diff --git a/README.md b/README.md index e69de29..0aa1f29 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +Mélange de Telegram et Betaseries ! Ce bot est avant-tout un entrainement et non un projet sérieux. +Le bot est séparé entre 2 programmes différents : + +1. Le bot Telegram, il utilise des commandes et peut vous faire voir ce que Betasérie permet. Vous pourrez aussi voir vos statistiques. Bien que son utilisateur est **optionnelle**. Vous besoin de mettre les deux fichiers dans le même dossier ! Ils communiquent entre eux. +2. Le script permettant de récupérer la liste des séries en cours et de vous notifier si jamais elle s'actualise. Le developpement n'a pas encore commandé + + +## Objectifs du projet : +1. Recevoir les notifications lorsqu'un épisode sort (En sachant que cette information vient de Betasérie et est donc imprécise) +2. Permettre de voir quelques informations sur telegram qui proviennent de Betasérie (synopsis, image, etc..) +3. Permettre 2 modes de communication : + 3.1. En utilisant le module Python de Telegram. + 3.2. En utilisant l'API web de Telegram + +## Lancer le projet : +Compatible Linux et Windows, vous aurez besoin de Python3 et de Pip (qui permettra d'installer les modules nécéssaires). +Installation de pip sur Windows : [ici](https://www.liquidweb.com/kb/install-pip-windows/) ; Installation de pip sur Debian : [ici](https://linuxize.com/post/how-to-install-pip-on-debian-9/) +``` +$pip install requests +$pip install telegram +``` +Lancez le script désiré avec Python. + +## Screenshots : \ No newline at end of file