Skip to content

Commit 72573f5

Browse files
committed
chore: update README, F-Droid metadata, funding
1 parent 73451a8 commit 72573f5

File tree

3 files changed

+46
-40
lines changed

3 files changed

+46
-40
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
ko_fi: cyb3rko
2-
patreon: cyb3rko
2+
buy_me_a_coffee: cyb3rko
33
custom: https://paypal.me/cyb3rko

README.md

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
1-
## ⚠️ Breaking Changes ⚠️
2-
If you have never used PINcredible, you can skip this section.
3-
If you have already used this app, please note that:
4-
- The stable release 1.0.0 uses a different package name and app signature, so you most have to uninstall the currently installed version and install the new version.
5-
- Your data from app versions older than 1.0.0a will not work anymore beginning with version 1.0.0a.
6-
That is because of an internal rehaul of the persisting features.
7-
8-
Before upgrading save your PINs outside of PINcredible to be able to reenter them in version 1.0.0a and later.
9-
Thank you for your understanding!
10-
11-
<h1 align="center">PINcredible - Secure PIN vault</h1>
1+
<h1 align="center">PINcredible - Secure PIN vault 🔐</h1>
122

133
<p align="center">
14-
<a href="https://apilevels.com"><img alt="API level" src="https://proxy.cyb3rko.de/shields/badge/API-23%2B-coral?logo=android&logoColor=white"></a>
4+
<a href="https://matrix.to/#/#cyb3rko-community:matrix.org"><img alt="Matrix room" src="https://proxy.cyb3rko.de/shields/matrix/cyb3rko-community%3Amatrix.org?logo=matrix&label=Matrix%20Chat&color=black"/></a>
5+
<a href="https://apilevels.com"><img alt="API level" src="https://proxy.cyb3rko.de/shields/badge/API-26%2B-coral?logo=android&logoColor=white"></a>
156
<a href="https://f-droid.org/packages/de.cyb3rko.pincredible"><img alt="F-Droid release" src="https://proxy.cyb3rko.de/shields/f-droid/v/de.cyb3rko.pincredible.svg?logo=fdroid&color=blue"></a>
167
<a href="https://github.com/cyb3rko/pincredible/releases/latest"><img alt="GitHub release" src="https://proxy.cyb3rko.de/shields/github/v/release/cyb3rko/pincredible.svg?logo=github"></a>
178
<a href="https://github.com/cyb3rko/pincredible/commits/main"><img alt="Last commit" src="https://proxy.cyb3rko.de/shields/github/last-commit/cyb3rko/pincredible?color=F34C9F&logo=git&logoColor=white"></a>
@@ -20,11 +11,9 @@ Thank you for your understanding!
2011
</p>
2112

2213
<p align="center">
23-
<img alt="PINcredible logo" src="https://i.imgur.com/hwfoyYb.png" width="120"/>
24-
</p>
25-
26-
<p align="center">
27-
<font size="+1">Part of </font><a href="https://github.com/cyb3rko/backpack-apps"><font size="+1">BackPack</font></a>
14+
<img alt="PINcredible logo" src="https://i.imgur.com/hwfoyYb.png" width="120"/><br>
15+
<font size="+1">Part of </font><a href="https://github.com/cyb3rko/backpack-apps"><font size="+1">BackPack</font></a><br><br>
16+
<a href="https://github.com/cyb3rko/pincredible/releases"><img alt="Direct downloads count" src="https://proxy.cyb3rko.de/shields/github/downloads/cyb3rko/pincredible/total?logo=github&label=direct%20downloads&color=blue"/></a>
2817
</p>
2918

3019
---
@@ -35,19 +24,26 @@ Thank you for your understanding!
3524
- [Legal Liability](#legal-liability)
3625
- [Download](#download)
3726
- [Verification](#verification)
38-
- [Supported devices](#supported-devices)
3927
- [Screenshots](#screenshots)
28+
- [Supported devices](#supported-devices)
4029
- [Security Aspects](#security-aspects)
4130
- [Contribute](#contribute)
31+
- [Donate](#donate)
4232
- [Used Icons](#used-icons)
4333
- [License](#license)
4434

4535
---
4636

4737
## About this project
38+
4839
Over time I've used several apps to store my PINs, unfortunately none of them really convinced me.
4940
So here we are now, this is my own implementation of a secure PIN manager.
5041

42+
If you think it's worth to support this project, feel free to give a small donation ❤️ ([Donate](#donate)).
43+
44+
Join the Community Matrix room to talk with the community about the app or to ask me (the dev) anything:
45+
https://matrix.to/#/#cyb3rko-community:matrix.org
46+
5147
## Feature Overview
5248
| | PINcredible | Others |
5349
| --- | --- | --- |
@@ -80,7 +76,7 @@ In addition to the default color palette PINcredible offers an accessible color
8076
## Legal Liability
8177

8278
In no way do I accept liability for lost PINs and the resulting consequences or other consequences of using the app.
83-
Especially in the beta phase, but also afterwards, I do not guarantee that the app will always work properly and PINs will never be lost.
79+
I do not guarantee that the app will always work properly and PINs will never be lost.
8480

8581
If you don't agree please don't use this app.
8682

@@ -118,15 +114,15 @@ Certificate Digests:
118114
MD5: 67:bb:02:ca:3c:ba:20:63:f7:a8:1c:0f:88:dd:59:38
119115
```
120116

121-
## Supported Devices
122-
The minimum supported Android version is API level 23, Android 6 (Marshmallow).
123-
Additionally this app takes advantage of the Android KeyStore system. At the moment I'm assuming every Android device with Android 6 upwards has this built-in.
124-
If you have any problems, maybe even because your device seems to be incompatible, please leave a message [here](https://github.com/cyb3rko/pincredible/issues).
125-
126117
## Screenshots
127118
|<img src="https://i.imgur.com/APgDeAl.png" width="270">|<img src="https://i.imgur.com/WHCXpG3.png" width="270">|<img src="https://i.imgur.com/zPESUDi.png" width="270">|
128119
|:---:|:---:|:---:|
129120

121+
## Supported Devices
122+
The minimum supported Android version is API level 26, Android 8.0 (Oreo "O").
123+
Additionally this app takes advantage of the Android KeyStore system. At the moment I'm assuming every Android device with Android 8.0 upwards has this built-in.
124+
If you have any problems, maybe even because your device seems to be incompatible, please leave a message [here](https://github.com/cyb3rko/pincredible/issues).
125+
130126
## Security Aspects
131127
Let's take a look at the technical details.
132128

@@ -162,7 +158,7 @@ Find the detailed explanation below.
162158
- retrieval of symmetric AES key
163159
- encrypt and save PIN pattern to file, append chosen PIN name to PIN name file (for the home screen)
164160

165-
That's the whole magic behind PINcredible, if you have questions or if you are a Security Expert and you have recommendations for improving the overall security, please tell me [via the issues](https://github.com/cyb3rko/pincredible/issues) or via e-mail: niko @ cyb3rko.de.
161+
That's the whole magic behind PINcredible, if you have questions or if you are a Security Expert and you have recommendations for improving the overall security, please tell me [via the issues](https://github.com/cyb3rko/pincredible/issues) or via e-mail: cyb3rko @ pm.me
166162

167163
## Contribute
168164
Of course I'm happy about any kind of contribution.
@@ -171,20 +167,27 @@ For creating [issues](https://github.com/cyb3rko/pincredible/issues) there's no
171167
If you create [pull requests](https://github.com/cyb3rko/pincredible/pulls) please try to use the syntax I use.
172168
Using a unified code format makes it much easier for me and for everyone else.
173169

170+
## Donate
171+
172+
If you think it's worth to support this project, feel free to give a small donation :heart:.
173+
Find the links here or in the section 'Sponsor this project' of this repo:
174+
175+
- [ko-fi.com/cyb3rko](https://ko-fi.com/cyb3rko) 🫶
176+
- [buymeacoffee.com/cyb3rko](https://buymeacoffee.com/cyb3rko)
177+
- [paypal.me/cyb3rko](https://paypal.me/cyb3rko) 💳
178+
174179
## Used Icons
175180

176-
| 💛 |
177-
| --- |
178-
| <a href="https://www.flaticon.com/free-icons/color-blindness-test" title="color-blindness-test icons">Color-blindness-test icons created by Freepik - Flaticon</a> |
179-
| <a href="https://www.flaticon.com/free-icons/grid" title="grid icons">Grid icons created by prettycons - Flaticon</a> |
180-
| <a href="https://www.flaticon.com/free-icons/random" title="random icons">Random icons created by Uniconlabs - Flaticon</a> |
181+
- [Color-blindness-test icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/color-blindness-test)
182+
- [Grid icons created by prettycons - Flaticon](https://www.flaticon.com/free-icons/grid)
183+
- [Random icons created by Uniconlabs - Flaticon](https://www.flaticon.com/free-icons/random)
181184

182185
## Star History
183186

184187
<picture>
185-
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=cyb3rko/pincredible&type=Date&theme=dark" />
186-
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=cyb3rko/pincredible&type=Date" />
187-
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=cyb3rko/pincredible&type=Date" />
188+
<source media="(prefers-color-scheme: dark)" srcset="https://proxy.cyb3rko.de/stars/svg?repos=cyb3rko/pincredible&type=Date&theme=dark" />
189+
<source media="(prefers-color-scheme: light)" srcset="https://proxy.cyb3rko.de/stars/svg?repos=cyb3rko/pincredible&type=Date&theme=light" />
190+
<img alt="Star History Chart" src="https://proxy.cyb3rko.de/stars/svg?repos=cyb3rko/pincredible&type=Date&theme=light" />
188191
</picture>
189192

190193
## License

metadata/en-US/full_description.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,21 @@
22
Over time I've used several apps to store my PINs, unfortunately none of them really convinced me.
33
So here we are now, this is my own implementation of a secure PIN manager.
44

5+
If you think it's worth to support this project, feel free to give a small donation ❤️ (<a href="https://github.com/cyb3rko/pincredible#donate">Donate</a>).
6+
7+
Join the Community Matrix room to talk with the community about the app or to ask me (the dev) anything:
8+
https://matrix.to/#/#cyb3rko-community:matrix.org
9+
510
<b>Features</b>
6-
<ul><li>🔢 PIN obfuscation</li><li>🔐 Local Encryption</li><li>🎨 Modern Design</li><li>🌐 No Internet Connection required</li><li>🎞️ No Ads</li><li>🗿 No Suspicious Permissions</li></ul>
11+
<ul><li>🔢 PIN obfuscation</li><li>🔐 Local encryption</li><li>🎨 Modern design</li><li>🌐 No internet connection</li><li>🎞️ No ads</li><li>🗿 No suspicious permissions</li></ul>
712

8-
The app obfuscates the PIN in a table layout surrounded by secure random numbers.
13+
The app obfuscates the PIN in a table layout surrounded by secure random numbers.
914
This brings two security benefits:
1015
1. ❔ The app can not know where in the pattern the user given PIN is located at. Attackers can not extract the plaintext PIN.
1116
2. 🕵️ This offers protection against <a href="https://en.wikipedia.org/wiki/Shoulder_surfing_(computer_security)" title="shoulder surfing">Shoulder Surfing</a>, for example while accessing your PIN in a super market or a bank.
1217

1318
<b>Security Aspects</b>
14-
For technical details about the implemented security take a look at the <a href="https://github.com/cyb3rko/pincredible" title="pincredible github">GitHub repo readme</a>.
19+
For technical details about the implemented security take a look at the <a href="https://github.com/cyb3rko/pincredible#security-aspects" title="PINcredible GitHub repo">GitHub README</a>.
1520

1621
<b>Used Icons</b>
17-
<a href="https://www.flaticon.com/free-icons/color-blindness-test" title="color-blindness-test icons">Color-blindness-test icons created by Freepik - Flaticon</a>
18-
<a href="https://www.flaticon.com/free-icons/grid" title="grid icons">Grid icons created by prettycons - Flaticon</a>
19-
<a href="https://www.flaticon.com/free-icons/random" title="random icons">Random icons created by Uniconlabs - Flaticon</a>
22+
<ul><li><a href="https://www.flaticon.com/free-icons/color-blindness-test" title="color-blindness-test icons">Color-blindness-test icons created by Freepik - Flaticon</a></li><li><a href="https://www.flaticon.com/free-icons/grid" title="grid icons">Grid icons created by prettycons - Flaticon</a></li><li><a href="https://www.flaticon.com/free-icons/random" title="random icons">Random icons created by Uniconlabs - Flaticon</a></li></ul>

0 commit comments

Comments
 (0)