Skip to content

Commit 7991381

Browse files
authored
Update README.md file
1 parent f00ab59 commit 7991381

1 file changed

Lines changed: 27 additions & 16 deletions

File tree

Mail_Checker/README.md

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,54 @@
1-
# Mail Checker
1+
<!--Please do not remove this part-->
2+
![Star Badge](https://img.shields.io/static/v1?label=%F0%9F%8C%9F&message=If%20Useful&style=style=flat&color=BC4E99)
3+
![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)
24

5+
# Script Title
36

7+
Mail Checker Application
48

5-
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!
9+
<!--An image is an illustration for your project, the tip here is using your sense of humour as much as you can :D
610
7-
# Prerequisites
8-
9-
Before you try to execute this script make sure you allow less secure app access in your google account
11+
You can copy paste my markdown photo insert as following:
12+
<p align="center">
13+
<img src="your-source-is-here" width=40% height=40%>
14+
-->
1015

11-
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.
16+
## 🛠️ Description
17+
<!--Remove the below lines and add yours -->
18+
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!
1219

20+
## ⚙️ Languages or Frameworks Used
21+
<!--Remove the below lines and add yours -->
1322

1423
We only require 'imaplib' python library to run this, this package is built-in to python, just import and use it!
1524

1625
import imaplib
1726

18-
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!
27+
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!
1928

2029
pip install -r requirements.txt
2130

2231

2332
Once you do this your script should be ready to use, make sure to add your account credentials and make other personalizations.
2433

25-
# Running the code
34+
## 🌟 How to run
35+
<!--Remove the below lines and add yours -->
36+
Before you try to execute this script make sure you allow less secure app access in your google account
37+
38+
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.
2639

2740
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.
2841

2942
It should look something like this!
3043

31-
<p align="center">
44+
## 📺 Demo
3245

3346
<img src="https://cdn.dribbble.com/users/10478669/screenshots/17309470/media/7bf794ce3bbba78c4fa8c5cbd0234cc7.png?compress=1&resize=800x600&vertical=top">
3447

35-
</p>
36-
37-
And thats it!
38-
39-
48+
## 🤖 Author
49+
<!--Remove the below lines and add yours -->
50+
Name: Siddharth Pradeep
4051

41-
## Author
52+
Git User Name: thirt33n
4253

43-
Siddharth Pradeep :)
54+
Git URL: https://github.com/thirt33n

0 commit comments

Comments
 (0)