aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1d615a9d..7eaf3f25 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,20 @@ This is a maintained fork of
which was archived in October 2024. All credit for the original work goes to the
Android Password Store authors.
+## Documentation
+
+How to install, set up and use the app: <https://danix.xyz/hardenedpass/>.
+
+New to `pass`? "Your own password store" is a beginner tutorial series, also available in
+[Italian](https://danix.xyz/it/articles/your-own-password-store-part-1/):
+
+1. [Create the store](https://danix.xyz/articles/your-own-password-store-part-1/) with `pass`,
+ GPG and git.
+2. [Choose a git host](https://danix.xyz/articles/your-own-password-store-part-2/), or do it all
+ from the phone with Termux.
+3. [Install HardenedPass](https://danix.xyz/articles/your-own-password-store-part-3/), connect it
+ to the store, and cover daily use and recovery.
+
## Changes from upstream
- Decrypts messages GnuPG 2.3+ writes by default (OCB / LibrePGP AEAD), which upstream rejected
@@ -21,6 +35,7 @@ Android Password Store authors.
- Decrypt screen no longer reachable by other apps with arbitrary file paths.
- No build scans uploaded to third-party services.
- No crash reporting (Sentry) and no Google Play Services; a single FOSS build.
+- Needs Android 12 or later.
- Own application ID (`xyz.danix.hardenedpass`): installs next to upstream instead of over it.
## Building
@@ -40,6 +55,15 @@ Services.
Report bugs and feature requests on the
[issue tracker](https://github.com/danixland/HardenedPass/issues).
+Report security issues privately by email instead, as described in
+[SECURITY.md](SECURITY.md).
+
+## Support
+
+HardenedPass will always be free, but maintaining a software can be costly, so if you found this piece of software useful, you can buy me a coffee.
+All donations will help me maintain HardenedPass in the future.
+
+[![Support on Ko-fi](media/kofi-button.png)](https://ko-fi.com/K6Y520C9I6)
## License