From 79913812749f52cc10bda70c834cfc20a5c282a0 Mon Sep 17 00:00:00 2001 From: Adrian Adewunmi Date: Mon, 17 Oct 2022 16:01:12 +0100 Subject: [PATCH] Update README.md file --- Mail_Checker/README.md | 43 ++++++++++++++++++++++++++---------------- 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/Mail_Checker/README.md b/Mail_Checker/README.md index 335c87f6..3a7a1062 100644 --- a/Mail_Checker/README.md +++ b/Mail_Checker/README.md @@ -1,43 +1,54 @@ -# Mail Checker + +![Star Badge](https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=style=flat&color=BC4E99) +![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103) +# Script Title +Mail Checker Application -Mail-Checker is a python script that lets you read your gmail subjects from particular gmail accounts directly from the terminal without having to login each time! + -To allow less secure apps click [here to go to your google account]( https://myaccount.google.com/lesssecureapps ). Allowing this does not compromise the security of your account! It only gives permission for applications such as this one to remotely check your emails. +## 🛠️ Description + +Mail-Checker is a python script that lets you read your gmail subjects from particular gmail accounts directly from the terminal without having to login each time! +## ⚙️ Languages or Frameworks Used + We only require 'imaplib' python library to run this, this package is built-in to python, just import and use it! import imaplib -I have attached a requirements.txt file that will install the neccessary python library needed for this script, in case if it turns out to be missing in your system.Run the command given below in the shell to install the requirements! +I have attached a requirements.txt file that will install the neccessary python library needed for this script, in case if it turns out to be missing in your system. Run the command given below in the shell to install the requirements! pip install -r requirements.txt Once you do this your script should be ready to use, make sure to add your account credentials and make other personalizations. -# Running the code +## 🌟 How to run + +Before you try to execute this script make sure you allow less secure app access in your google account + +To allow less secure apps click [here to go to your google account]( https://myaccount.google.com/lesssecureapps ). Allowing this does not compromise the security of your account! It only gives permission for applications such as this one to remotely check your emails. Run the code the same way you would run any python code ie, such as in text editors or IDEs like VSCode and view your outputs in your terminal window. It should look something like this! -

+## 📺 Demo -

- -And thats it! - - +## 🤖 Author + +Name: Siddharth Pradeep -## Author +Git User Name: thirt33n -Siddharth Pradeep :) \ No newline at end of file +Git URL: https://github.com/thirt33n