Skip to content

Commit 016a12a

Browse files
Improve README formatting and add badges
Updated the README to enhance formatting and add badges.
1 parent 6852642 commit 016a12a

File tree

1 file changed

+18
-29
lines changed

1 file changed

+18
-29
lines changed

simple-contact-book/README.md

Lines changed: 18 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,33 @@
1-
## 📒 Contact Book (Python)
1+
<h1 align="center"> Contact Book (Python)</h1>
22

3-
A simple **Contact Book** application built with Python classes.
4-
It lets you store contact information (name & phone number) and display saved contacts.
3+
<p align="center">
4+
A simple, class-based <b>Contact Book</b> application built with Python.
5+
Store and manage contact information (name & phone number) directly from the terminal.
6+
</p>
57

6-
---
8+
<p align="center">
9+
<a href="https://www.python.org/"><img src="https://img.shields.io/badge/Python-3.x-blue?style=for-the-badge&logo=python"></a>
10+
<a href="#"><img src="https://img.shields.io/badge/Platform-Terminal-orange?style=for-the-badge&logo=windowsterminal"></a>
11+
<a href="https://github.com/mantrapatil03/python-beginner-friendly-projects/stargazers"><img src="https://img.shields.io/badge/Stars-GitHub-yellow?style=for-the-badge&logo=github"></a>
12+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green?style=for-the-badge&logo=opensourceinitiative"></a>
13+
</p>
714

8-
## 🚀 Features
15+
## Features
916
- Add new contacts
1017
- Store multiple contacts
1118
- Display all saved contacts in a clean format
1219

13-
14-
1520
---
1621

17-
## 🛠️ How It Works
22+
## How It Works
1823
1. Each contact is represented by the `Contact` class.
1924
2. All contacts are stored inside the `ContactBook` class.
2025
3. You can add new contacts using `add_contact()` and display them with `show_contacts()`.
2126

2227

2328
---
2429

25-
## 💻 Example Usage
30+
## Example Usage
2631
```python
2732
from contact_book import Contact, ContactBook
2833

@@ -37,35 +42,19 @@ contact_book.add_contact(Contact("Ram", "987-654-3210"))
3742
contact_book.show_contacts()
3843
```
3944

40-
## 🖥️ Output:
45+
## Output:
4146
```python
4247
Name: Shree, Phone: 123-456-7890
4348
Name: Ram, Phone: 987-654-3210
4449
```
4550

46-
## 📌 Future Improvements
47-
48-
49-
Save contacts permanently (using JSON/CSV/Database)
50-
51-
Search & delete contacts
52-
53-
Update existing contacts
5451

55-
Simple command-line or GUI interface
52+
## Author
5653

57-
## 🏷️ Author
58-
59-
Made with ❤️ by Mantra Patil
60-
61-
🌐 GitHub: https://github.com/mantrapatil03
54+
Made with ❤️ by **Mantra Patil**
6255

6356
💼 LinkedIn: https://www.linkedin.com/mantrapatil25
6457

6558
techmantrapatil@gmail.com
6659

67-
68-
69-
70-
71-
60+
<h3 align="center">⭐ If you found this project useful, give it a star on GitHub! ⭐</h3> <p align="center"> <img src="https://img.shields.io/badge/Keep%20Organizing%20%26%20Coding-Python-blue?style=for-the-badge&logo=python"> </p>

0 commit comments

Comments
 (0)