0
0
mirror of https://github.com/TrianguloY/UrlChecker.git synced 2024-09-19 20:02:16 +02:00
UrlChecker/README.md

91 lines
3.8 KiB
Markdown
Raw Normal View History

2022-08-07 11:41:21 +02:00
<!-- ---------- Header ---------- -->
2022-08-06 15:18:13 +02:00
<div align="center">
2022-08-07 11:41:21 +02:00
<img src="./app/src/main/play/listings/en-US/graphics/feature-graphic/featured.png">
2022-08-07 13:44:22 +02:00
<!-- Original background with CC0 from https://www.maxpixel.net/Digital-Network-Internet-Communication-Connections-3537400 -->
2022-08-05 17:06:39 +02:00
2022-08-06 15:18:13 +02:00
<h1>Url Checker</h1>
2022-08-07 11:41:21 +02:00
<h3>Android app made by TrianguloY</h3>
</div>
2022-08-06 15:18:13 +02:00
2022-08-07 11:41:21 +02:00
<!-- ---------- Badges ---------- -->
2022-08-06 15:18:13 +02:00
<div align="center">
2022-08-07 11:35:32 +02:00
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/TrianguloY/UrlChecker?color=white&label=Github%20version)
![F-Droid](https://img.shields.io/f-droid/v/com.trianguloy.urlchecker?label=F-droid%20version)
2022-08-07 11:41:21 +02:00
![PlayShields](https://img.shields.io/endpoint?color=green&url=https%3A%2F%2Fplayshields.herokuapp.com%2Fplay%3Fi%3Dcom.trianguloy.urlchecker%26l%3DPlay%2520Store%2520version%26m%3D%24version)
2022-08-06 15:33:53 +02:00
[![patreon](https://img.shields.io/badge/patreon-Donate-orange)](https://www.patreon.com/bePatron?u=24747112)
2022-08-06 15:18:13 +02:00
</div>
2022-08-05 17:06:39 +02:00
2022-08-07 11:41:21 +02:00
<!-- ---------- Download ---------- -->
2022-08-06 18:19:38 +02:00
<div align="center">
2022-08-07 11:41:21 +02:00
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png"
alt="Get it on Google Play"
height="80">](https://play.google.com/store/apps/details?id=com.trianguloy.urlchecker) [<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/com.trianguloy.urlchecker/) </div>
2022-08-06 18:18:52 +02:00
<!-- <details><summary><h4>links</h4></summary>
2022-08-06 14:21:17 +02:00
- Google Play: https://play.google.com/store/apps/details?id=com.trianguloy.urlchecker
- FDroid: https://f-droid.org/packages/com.trianguloy.urlchecker/
2022-08-06 18:18:52 +02:00
</details> -->
2022-08-07 11:41:21 +02:00
<!-- ---------- Description ---------- -->
2022-08-06 18:18:52 +02:00
<div align="center">
2022-08-07 11:41:21 +02:00
2022-08-06 18:18:52 +02:00
**Url Checker** acts as an intermediary when opening url links, allowing, among other things:
2022-08-05 19:41:31 +02:00
to remove trackers, affiliate links, unnecessary elements,
facilitating link sharing, protecting against certain phishing techniques and many more...
2022-08-07 11:41:21 +02:00
2022-08-06 18:18:52 +02:00
</div>
2022-08-05 17:06:39 +02:00
2022-08-07 11:41:21 +02:00
<!-- ---------- Screenshots ---------- -->
2022-08-05 19:20:51 +02:00
<p align="center">
<img
2022-08-07 11:25:41 +02:00
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/1-title.png"
2022-08-05 19:20:51 +02:00
height="400">
<img
2022-08-07 11:25:41 +02:00
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/2-dialog.png"
2022-08-05 19:20:51 +02:00
height="400">
<img
2022-08-07 11:25:41 +02:00
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/3-modules.png"
2022-08-05 19:20:51 +02:00
height="400">
<img
2022-08-07 11:25:41 +02:00
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/4-modules.png"
2022-08-05 19:20:51 +02:00
height="400">
</p>
2022-08-07 11:21:59 +02:00
</div>
2022-08-05 19:20:51 +02:00
2022-08-07 11:41:21 +02:00
<!-- ---------- Contribution ---------- -->
2022-08-06 13:03:00 +02:00
## Contribution
2022-02-10 22:43:08 +01:00
2022-08-06 15:22:38 +02:00
**All help is greatly welcomed!**
2022-08-06 11:09:21 +02:00
Feel free to **suggest changes**, create [**issues**](https://github.com/TrianguloY/UrlChecker/issues/new) or even [**pull request**](https://help.github.com/articles/about-pull-requests/). _(from a simple typo fix to a full new module or even more!)_
2022-02-10 22:43:08 +01:00
I don't have a coding style, but try to keep it similar to mine, with just a couple notes:
2022-08-06 16:43:33 +02:00
- Please write comments. No need to write full paragraphs for each line, but at least a minor comment for functions, **non-obvious blocks of code really help.**
2022-02-10 22:43:08 +01:00
- Try to make small commits, when possible, I'll need to review you changes manually so help me understand it.
2022-08-07 11:41:21 +02:00
<!-- ---------- License ---------- -->
2022-08-05 17:57:28 +02:00
## License
2022-02-10 22:43:08 +01:00
2022-08-07 11:41:21 +02:00
<div align="center">
[<img src="https://mirrors.creativecommons.org/presskit/buttons/88x31/png/by.png"
alt="Creative Commons Attribution 4.0 International"
height="80">](http://creativecommons.org/licenses/by/4.0/)
</div>
2022-02-10 22:43:08 +01:00
You can use parts of this project in your own ones, or upload modified versions of it AS LONG AS you credit me.
2020-09-28 20:15:12 +02:00
2022-08-05 17:06:39 +02:00
**How to credit:**
2022-02-10 22:43:08 +01:00
2022-08-05 21:51:28 +02:00
- You must add my nick [TrianguloY](https://github.com/TrianguloY/) in an `about` or `acknowledgments` section visible to the user.
2022-08-05 17:06:39 +02:00
- You must add a link to this GitHub main page **https://github.com/TrianguloY/UrlChecker** or subpage (if you used a part of the code or an asset) in an `about` or `acknowledgments` section visible to the user.