Skip to content

Commit 757eba3

Browse files
committed
Added readme and License files.
1 parent a16cc35 commit 757eba3

File tree

2 files changed

+86
-0
lines changed

2 files changed

+86
-0
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Reynaldo Rea
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Password Manager
2+
3+
A simple, secure desktop password manager built with Electron and TypeScript.
4+
5+
## Installation
6+
7+
### Prerequisites
8+
9+
- Node.js (v18 or higher)
10+
- npm
11+
12+
### Building
13+
14+
Build for your platform:
15+
16+
```bash
17+
# Build for current platform
18+
npm run dist
19+
20+
# Build for Windows
21+
npm run dist:win
22+
23+
# Build for Linux
24+
npm run dist:linux
25+
```
26+
27+
The built application will be available in the `release/` directory.
28+
29+
## Usage
30+
31+
### First Run
32+
33+
1. Launch the application
34+
2. Create a master password (minimum 4 characters)
35+
3. This password encrypts all your data - don't lose it!
36+
37+
### Password Generator
38+
39+
- Click the key icon in the password field or toolbar
40+
- Adjust length and character types
41+
- Click "Use" to apply or "Copy" to copy to clipboard
42+
43+
### Settings
44+
45+
- **Theme**: Toggle between light and dark mode
46+
- **Auto-Lock**: Set inactivity timeout (0 to disable)
47+
- **Change Master Password**: Update your master password (re-encrypts all data)
48+
49+
## Security
50+
51+
- All passwords are encrypted using AES-256-CBC
52+
- Master password is hashed with SHA-256
53+
- Database stored locally in user data directory
54+
- No cloud sync or external connections
55+
56+
## License
57+
58+
MIT License - See LICENSE file for details
59+
60+
## Author
61+
62+
Reynaldo Rea - [Reynaldo.rea48@outlook.com](mailto:Reynaldo.rea48@outlook.com)
63+
64+
## Logo
65+
<a href="https://www.flaticon.com/free-icons/lock" title="lock icons">Lock icons created by Freepik - Flaticon</a>

0 commit comments

Comments
 (0)