Skip to content
This repository was archived by the owner on Oct 11, 2020. It is now read-only.

Commit 2dfe166

Browse files
committed
Updated README
1 parent bf50005 commit 2dfe166

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

+38-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
11
# phonebook-gui
22
GUI version of the [phonebook app](https://github.com/AritificialPhysics/phonebook)
33

4-
Works in the exact way as the above does, just uses a Graphical Interface. Actions are handled through buttons, and text input is handled through entry fields.
5-
Utilizes the tkinter framework of Python.
4+
Portable and fast python GUI application that provides contact management capabilities for different users.
5+
6+
## Features:
7+
- Easy to use graphical interface, powered by tkinter
8+
- Seperate contact list maintained for each user, thus providing discretion and organization
9+
- Encrypted user credentials (uses SHA-256)
10+
- Persistance maintained through embedded sqlite3 database
11+
- Highly fault tolerant and secure
12+
- High scalability and high execution speed
13+
14+
---
15+
16+
## Components:
17+
18+
### User Managagement:
19+
- Add User (username, password validation along with redundancy detection)
20+
- Remove user
21+
- Select user (gateway to contact management module)
22+
23+
### Contact Management:
24+
- Add contact (contact info validated by using Regex matching)
25+
- Remove contact (matching based on name, case insensitive)
26+
- View All Contacts
27+
- Modify contact (contact info validation)
28+
- Search Contact (matching based on name, case insensitive)
29+
30+
---
31+
32+
## Contributors (in alphabetical order)
33+
- Anuj Kumar Singh (Programmer)
34+
- Sanskar Agrawal (Programmer and Integrator)
35+
- Saumy Pandey (Programmer)
36+
- Som Shiv Gupta (Analyst)
37+
- Siddhant Singh (Testing and QA)
38+
39+
---
40+
41+
[Raise an issue](https://github.com/aritificialphysics/phonebook-gui/issues/new)

0 commit comments

Comments
 (0)