Skip to content

Commit 04e1928

Browse files
committed
Cleaned up README adn updated to v0.2.1
1 parent a851b67 commit 04e1928

File tree

1 file changed

+53
-36
lines changed

1 file changed

+53
-36
lines changed

README.md

Lines changed: 53 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,64 @@
11
# Python Password
22

3-
**Hello world!** This is my first project of usable program.
3+
**Hello world!** This is my very first project of usable program.
44

5-
*For now it's named as above, because I have no better idea how to name it. Here are some words about it.*
5+
### What is the program about?
66

7-
## What is the program about?
87
Python Password is intended to safely store passwords.
98

10-
## How does it work?
11-
Program is saving passwords to local database (SQLite database). Passwords are encrypted with a secret key, based
12-
on master password and salt, both could be a user input (or only the first one) so you can re-create the file
13-
when it's gone for some reasons. When you would like to get any password it won't be prompted on the screen, but
14-
safely copied to clipboard.
15-
16-
## Quick start guide for `v0.1.x`
17-
1. At very first launch, program will create 3 files:
18-
19-
- `Alpha.key`,
20-
- `Beta.key`,
21-
- `Passwords.db`.
22-
23-
All of them are needed for proper program functioning. Each subsequent start of the program is trying to find those
24-
files. Every missing file will be re-created.
25-
26-
2. After program will check files, you will se typical console GUI. You can provide option number, or underlined letter.
27-
Options are:
28-
29-
***Warning! UI is now under construction.***
30-
31-
1. **Change alpha password** - if you want to change your master password.
32-
2. **Get password** - program shows all saved passwords' names and asks which you want to get. Password isn't
33-
prompted, it's being copied to clipboard. (Same as <kbd>Ctrl + C</kbd>, <kbd>Ctrl + V</kbd>)
34-
3. **Set password** - used for saving password.
35-
4. **Delete password** - after double inserting password's name, that password is being deleted from local database.
36-
5. **Info** - useful links and info about the program.
37-
6. **Exit** - I think I don't have to describe it.
38-
39-
3. Program is working in loop, so it will continue working unless you will close the window or select `Exit` option.
9+
### How does it work?
10+
11+
Program is saving passwords to local database (SQLite database). Passwords are encrypted with a secret key, based on
12+
master password and salt, both could be a user input or random values, so you can re-create the file when it's gone for
13+
some reasons. When you would like to get any password it won't be prompted on the screen, but safely copied to
14+
clipboard.
15+
16+
## Quick start guide
17+
18+
19+
### Passwords menu
20+
21+
Maim screen of program is passwords menu. From here you can:
22+
23+
- add passwords,
24+
- copy passwords,
25+
- delete passwords.
26+
27+
On the left side there will be displayed list of saved passwords. Ypu can click on specific password to see context
28+
menu wth 3 options; "copy", "delete" and "nothing".
29+
30+
On the right side there are 4 sections.
31+
32+
1. **Adding password.** To add password, simply enter it's alias and password itself. Then click button to add it.
33+
2. **Removing password.** You can delete password also from here. Simply provide it's alias and click button.
34+
3. **Info.** - Here you can see how many passwords there are in database.
35+
4. **Refresh.** - Click this button to refresh view, and fetch passwords from local database.
36+
37+
38+
### Settings menu
39+
40+
In this menu, you can:
41+
42+
- change alpha password,
43+
- change beta password.
44+
45+
You can see in `FAQ.md` how do they work.
46+
47+
There will be also options to manage backups.
48+
49+
50+
### Info menu
51+
52+
On the left side, there are some basic information about version, author and 3rd party software.
53+
54+
On the right side you can see (of course clickable) links.
55+
4056

4157
## How to start using?
58+
4259
For download please look at [releases section](https://github.com/AnonymousX86/Python-Password/releases).
4360

44-
If you want to help me improve this program, (report issues etc.) please contact me via Discord: `Anonymous©#7296`,
45-
or use [GitHub issues](https://github.com/AnonymousX86/Python-Password/issues).
61+
---
4662

47-
### Thanks for all of your help!
63+
*If you want to help me improve this program, (report issues etc.) or just talk, please contact me via
64+
Discord: `Anonymous©#7296`, or use [GitHub issues](https://github.com/AnonymousX86/Python-Password/issues).*

0 commit comments

Comments
 (0)