Skip to content

Commit 42d52fb

Browse files
authored
Merge pull request RustedLessPass#34 from RustedLessPass/remade-README
docs(README.md): 📝 update README content to improve clarity, add key features section
2 parents 9342f31 + e0e583c commit 42d52fb

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# RustedLessPass
22

3-
A password manager built in Rust, compatible with [LessPass](https://github.com/lesspass/lesspass).
3+
**Tired of juggling weak passwords?** RustedLessPass empowers you to manage your login credentials securely and conveniently. Built with Rust and WebAssembly, RustedLessPass offers a platform-independent solution for your password needs.
44

5-
Powered by Yew for WebAssembly compatibility, it runs directly in your web browser, so there's no need for any server computation—only for delivering the app.
5+
## **Key Features:**
66

7-
Inspired by LessPass, it follows the same principles but works independently.
7+
- **LessPass Compatibility:** Enjoy a familiar user experience.
8+
- **WebAssembly Power:** Run RustedLessPass directly in your web browser, eliminating server-side dependencies and keeping your data entirely under your control.
9+
- **Cross-Platform Access:** Manage your passwords from any device with a modern web browser, no matter the operating system.
10+
- **Open-Source Transparency:** Benefit from the power and security of open-source development, allowing for community contributions and independent audits.
811

9-
This means you can generate strong passwords without relying on external servers.
12+
## **Installation:**
1013

11-
## [Installer](https://github.com/RustedLessPass/RustedLessPass/releases/latest)
12-
13-
For desktop users, convenient PC installers are accessible via [this link](https://github.com/RustedLessPass/RustedLessPass/releases/latest). If you're using a mobile device, please use the Progressive Web App (PWA) for seamless installation and usage.
14+
- **Recommended:** Use the Progressive Web App (PWA) version for seamless browser and device integration.
15+
- **Alternative:** Accessible installers are available for Firefox and traditional PC installs [link to installers](https://github.com/RustedLessPass/RustedLessPass/releases/latest).
1416

1517
## Screenshot
1618

@@ -28,9 +30,9 @@ To use RustedLessPass:
2830

2931
You can then use the generated password when signing up or logging into websites, without the need to store or remember individual passwords.
3032

31-
## Installation
33+
## **Building Locally (Optional):**
3234

33-
To run RustedLessPass locally, follow these steps:
35+
This section is intended for developers who want to contribute or run the application locally.
3436

3537
1. Clone the repository:
3638
```bash
@@ -62,13 +64,12 @@ Contributions to RustedLessPass are welcome! If you find any issues or have sugg
6264
Sincere gratitude to:
6365

6466
- [Pico CSS](https://picocss.com)
65-
- [lesspass](https://github.com/lesspass/lesspass)
67+
- [Lesspass](https://github.com/lesspass/lesspass)
6668
- [lesspass.rs](https://github.com/71/lesspass.rs)
69+
- [Tauri](https://tauri.app/)
6770
- [Yew Framework](https://yew.rs)
6871
- [Rust Programming Language](https://rust-lang.org)
6972

7073
## License
7174

7275
RustedLessPass is licensed under the [GPL-3.0 License](LICENSE).
73-
74-
<br/>README made with ChatGPT.

0 commit comments

Comments
 (0)