Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
Added all the required documentation.
  • Loading branch information
aekanshd authored Jan 10, 2018
1 parent 56b64bb commit 4d748d8
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,27 @@
# password-keeper
# Password Keeper
A simple and secure Password Management System made completely in Python.

## Installation
### Installing the files
Run the file **"installaltion/install.py"** to install the program files.
### Running the program
Look for a folder **"Password Keeper"** in the same directory as the install.py and run the file **"main.py"** inside it.

## Required Modules
This Python Project uses the following dependencies:
1. Tkinter Module (Tkinter3 for Python3.6)

## Features
1. The entire program is authenticated with one Global Password - so you don't have to remember individual passwords of your accounts, just remember one - and we'll take care of the rest.
2. Added security - each action you do, such as deleting an account - will require your global password so that no one can misuse your data while it's running.
3. Each entry has an option to enter Account Name, Username, and Password.
4. Double encrpytion - the data files, and passwords are encrypted twice in unique algorithms making your data extra secure.
5. Unlock/Lock Session - Tired of re-entering your global password each time you want to decrypt data? Just unlock the current session and we won't ask for your global password while the session is unlocked. You can lock the session again by just the tap of a button. (or close the program altogether)
6. Copy Password - Password too lengthy or complicated to type? Just tap the Copy Password button and we'll copy it to your clipboard.

## Source Code
The entire source code of the program is stored under the **"raw"** folder. Feel free to modify/reuse as you like. Make sure you credit me somewhere, though.

## Contribution
Everyone is welcome to contribute to this project and build more functionality into it. Make a fork, imporve/fix it and create a pull request. I'd love it! :)
Also, I'll be mentioning your names over here!

0 comments on commit 4d748d8

Please sign in to comment.