0
0
mirror of https://github.com/TrianguloY/UrlChecker.git synced 2024-09-19 20:02:16 +02:00
UrlChecker/README.md
TrianguloY d1eb512d04
Replace manual contributors with automated list on Readme
Also refactor a bit the header
2023-05-08 21:49:33 +02:00

90 lines
5.2 KiB
Markdown

<div align="center">
<!-- ---------- Header ---------- -->
<img src="./docs/featured.png">
<!-- Original background with CC0 from https://www.maxpixel.net/Digital-Network-Internet-Communication-Connections-3537400 -->
<!-- title -->
# URLCheck
<!-- ---------- Badges ---------- -->
[![App-Code Size](https://img.shields.io/github/languages/code-size/trianguloy/urlchecker.svg)](https://api.github.com/repos/TrianguloY/UrlChecker)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/TrianguloY/UrlChecker)](https://github.com/TrianguloY/UrlChecker/pulse/monthly)
[![Weblate (translation percentage)](https://hosted.weblate.org/widgets/urlcheck/-/svg-badge.svg)](https://hosted.weblate.org/engage/urlcheck/)
[![GitHub version (gradle versionName)](https://img.shields.io/badge/dynamic/json?label=Latest%20version&color=white&query=version&url=https%3A%2F%2Fgithub.com%2FTrianguloY%2FUrlChecker%2Freleases%2Fdownload%2Flatest%2Fshields.json)](https://github.com/TrianguloY/UrlChecker/blob/master/app/build.gradle)
[![F-Droid](https://img.shields.io/f-droid/v/com.trianguloy.urlchecker?label=F-Droid%20version)](https://gitlab.com/fdroid/fdroiddata/-/blob/master/metadata/com.trianguloy.urlchecker.yml)
[![PlayShields](https://img.shields.io/endpoint?color=green&url=https%3A%2F%2Fplay.cuzi.workers.dev%2Fplay%3Fi%3Dcom.trianguloy.urlchecker%26l%3DPlay%2520Store%2520version%26m%3Dv%24version)](https://play.google.com/store/apps/details?id=com.trianguloy.urlchecker)
<!-- ---------- Download ---------- -->
[<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)
[<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)
<hr width="50%">
<!-- contributors -->
### Android app made by [TrianguloY](https://github.com/TrianguloY)
Special contributors: [Ilithy](https://github.com/Ilithy), [PabloOQ](https://github.com/PabloOQ)
All contributors: \
[![Contributors](https://contrib.rocks/image?repo=TrianguloY/UrlChecker&anon=1)](https://github.com/TrianguloY/UrlChecker/graphs/contributors) \
and [404potato](https://github.com/404potato) and maybe some more from [Weblate](https://hosted.weblate.org/engage/urlcheck/).
<hr>
<!-- ---------- Description ---------- -->
**URLCheck** acts as an amazingly customizable and powerful intermediary when opening url links, allowing, among other things:
to remove trackers, affiliate links, unnecessary elements, check Hosts, facilitating link holding and sharing, protecting against certain phishing techniques and many more...
<!-- ---------- Screenshots ---------- -->
<div style="display: flex;">
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/1-title.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/2-dialog.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/3-dialog.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/4-modules.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/5-modules.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/6-modules.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/7-modules.png" width=30%>
<img src="app/src/main/play/listings/en-US/graphics/phone-screenshots/8-settings.png" width=30%>
</div>
</div>
<!-- ---------- Contribution & contributors ---------- -->
## Contribution
**All help is greatly welcomed!**
Feel free to [**suggest changes**](https://github.com/TrianguloY/UrlChecker/issues/new), request a [**new feature**](https://github.com/TrianguloY/UrlChecker/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=), create [**bug report**](https://github.com/TrianguloY/UrlChecker/issues/new?assignees=&labels=bug&template=bug_report.md&title=) 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!)_
**Translations are also greatly appreciated.**
See [CONTRIBUTING](docs/CONTRIBUTING.md) for code or translation details and tips.
[![Weblate (translation details)](https://hosted.weblate.org/widgets/urlcheck/-/multi-auto.svg)](https://hosted.weblate.org/engage/urlcheck/)
<!-- ---------- License ---------- -->
## License
<div align="center">
[<img src="https://mirrors.creativecommons.org/presskit/buttons/88x31/png/by.png"
alt="Creative Commons Attribution 4.0 International"
height="40">](http://creativecommons.org/licenses/by/4.0/)
</div>
You can use parts of this project in your own ones, or upload modified versions of it AS LONG AS you credit me.
**How to credit:**
- You must add my nick [**TrianguloY**](https://github.com/TrianguloY/) in an `about` or `acknowledgments` section visible to the user.
- 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.