Skip to content

Commit 8209d9e

Browse files
committed
docs: update README to clarify terminology from "password" to "passphrase"; add new features including passphrase generator and alternator; enhance project description and open source information
1 parent 7faa57b commit 8209d9e

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
![Tailscale](https://img.shields.io/badge/Tailscale-000000?style=for-the-badge&logo=tailscale&logoColor=white)
1212
</div>
1313

14-
Passenger-Go is a secure, self-hosted passphrase manager that runs in your local network. It provides a modern, responsive web interface for managing your passwords and sensitive information, with all data encrypted and stored locally on your server.
14+
Passenger-Go is a secure, self-hosted passphrase manager that runs in your local network. It provides a modern, responsive web interface for managing your passphrases and sensitive information, with all data encrypted and stored locally on your server.
1515

1616
Additionally provides an api, so you can use it in your own client projects.
1717

@@ -73,8 +73,10 @@ tailscale serve --port http://localhost:[YOUR_PORT_HERE]
7373
- **Favicon Support**: Automatic favicon fetching from websites using icon.horse
7474
- **URL Integration**: Click to open account websites in new tabs
7575
- **Real-time Search**: Instant search across platform names, usernames, and notes
76+
- **Passphrase Generator**: Generate strong passphrases with customizable length and complexity
77+
- **Passphrase Alternator**: Changes the given passphrase's characters to similar looking characters
7678
- **Responsive Design**: Works perfectly on desktop, tablet, and mobile devices
77-
- **Copy to Clipboard**: One-click copying of usernames and passwords
79+
- **Copy to Clipboard**: One-click copying of usernames and passphrases
7880
- **Import/Export**: Support for Firefox and Chromium CSV exports
7981
- **API Documentation**: Comprehensive API reference with interactive endpoint documentation
8082

@@ -84,9 +86,17 @@ Required environment variables:
8486

8587
- `JWT_SECRET`: Secret for JWT token generation
8688
- `AES_GCM_SECRET`: Secret for AES-GCM encryption
87-
- `SALT`: Salt for password hashing
89+
- `SALT`: Salt for passphrase hashing
8890
- `PORT`: Port to run the server on
8991

9092
## License
9193

9294
This project is licensed under the [GPL-3.0](LICENSE) license.
95+
96+
## Open Source
97+
98+
This project is open source and free to use. Feel free to contribute to the project.
99+
100+
## Why Not Saying "Password"
101+
102+
Passwords are obsolete and not secure. Passphrases are more secure and easier to remember. word means, a single word. phrase means, a group of words. How long is your "passkey" means how secure it is. By using phrases, you can remember them easier while being more secure.

0 commit comments

Comments
 (0)