From 1d3872d3415bf30fac167e1c1288e1c0c0d9d82b Mon Sep 17 00:00:00 2001 From: KrYmZiN <35653831+Shiv-Patil@users.noreply.github.com> Date: Sun, 16 May 2021 14:36:17 +0530 Subject: [PATCH] Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7bca4fe..42fb04b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,49 @@ -![icon](https://github.com/Shiv-Patil/Account-Safe/blob/main/res/icon.png?raw=true) +
+ Logo +
+ # Account Safe - A simple and secure app to store all your passwords in one place + +A simple and secure app to store all your passwords in one place + +With Account Safe, you can store all your account passwords safely in a secure encrypted form. A master password is used as an encryption key for the passwords. + +As this app doesn't have internet access, it is fully secure. + +This app supports multiple users. Up to 10 users can use the same app and have their own user account with master password. + +### Features + - Multi-user support + - No internet permission + - Encryption using SHA256 hash + - Backup your passwords to local storage + - Strong password generator built in + - Easily copy password to clipboard + - Customizable theme + +### Points to note + - If you lose or forget your master password, all passwords will be lost and will not be recoverable. + - In case of data loss, such as when the app is uninstalled or switched devices, it is recommended to make regular backups of your user account so that the data can be recovered. Made using [Kivy](https://kivy.org/ "Kivy homepage") + +# Installation + +## Binaries + +Android: [Coming Soon!] +Windows: [Releases](https://github.com/Shiv-Patil/Account-Safe/releases) +Deb-based Linux: [Releases](https://github.com/Shiv-Patil/Account-Safe/releases) + +## Running source code + +- (Optional) Create and activate a virtualenv +- Clone this reporitory or [download](https://github.com/Shiv-Patil/Account-Safe/archive/HEAD.zip) zip +- Change directory to `Account-Safe` +- Run `pip install -r requirements.txt` +- Run `python main.py` + +# Screenshots + +ScreenshotScreenshot +ScreenshotScreenshot