0
0
mirror of https://github.com/TrianguloY/UrlChecker.git synced 2024-09-19 20:02:16 +02:00
UrlChecker/README.md
Ilithy fc52cc0244
Update CONTRIBUTING.md (#65)
* Update CONTRIBUTING.md

(first step) added primary help for translators

* Update README.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

- added link to https://countrycode.org/ for country prefixes
- added the possibility to offer a translation via an issue (checked the requested title)

Co-authored-by: TrianguloY <correo--correo@hotmail.com>
2022-08-23 15:25:36 +02:00

100 lines
4.4 KiB
Markdown

<!-- ---------- Header ---------- -->
<div align="center">
<img src="./app/src/main/play/listings/en-US/graphics/feature-graphic/featured.png">
<!-- Original background with CC0 from https://www.maxpixel.net/Digital-Network-Internet-Communication-Connections-3537400 -->
# Url Checker
### Android app made by TrianguloY
Contributions: [Ilithy](https://github.com/Ilithy), [PabloOQ](https://github.com/PabloOQ) \
Translations: [Tiago Carmo](https://github.com/ReduxFlakes), [Ilithy](https://github.com/Ilithy), Idris, [Metezd](https://github.com/metezd), Nhman Mazuz
</div>
<!-- ---------- Badges ---------- -->
<div align="center">
[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/TrianguloY/UrlChecker?color=white&label=Latest%20version&sort=semver)](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%2Fplayshields.herokuapp.com%2Fplay%3Fi%3Dcom.trianguloy.urlchecker%26l%3DPlay%2520Store%2520version%26m%3Dv%24version)](https://play.google.com/store/apps/details?id=com.trianguloy.urlchecker)
[![App-Code Size](https://img.shields.io/github/languages/code-size/trianguloy/urlchecker.svg?label=Code%20size)](https://api.github.com/repos/TrianguloY/UrlChecker)
[![Patreon](https://img.shields.io/badge/Patreon-Donate-orange)](https://www.patreon.com/bePatron?u=24747112)
</div>
<!-- ---------- Download ---------- -->
<div align="center">
[<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)
</div>
<!-- <details><summary><h4>links</h4></summary>
- Google Play: https://play.google.com/store/apps/details?id=com.trianguloy.urlchecker
- FDroid: https://f-droid.org/packages/com.trianguloy.urlchecker/
</details> -->
<!-- ---------- Description ---------- -->
<div align="center">
**Url Checker** acts as an intermediary when opening url links, allowing, among other things:
to remove trackers, affiliate links, unnecessary elements,
facilitating link sharing, protecting against certain phishing techniques and many more...
</div>
<!-- ---------- Screenshots ---------- -->
<p align="center">
<img
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/1-title.png"
height="400">
<img
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/2-dialog.png"
height="400">
<img
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/3-dialog.png"
height="400">
<img
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/4-modules.png"
height="400">
<img
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/5-modules.png"
height="400">
<img
src="./app/src/main/play/listings/en-US/graphics/phone-screenshots/6-modules.png"
height="400">
</p>
</div>
<!-- ---------- Contribution ---------- -->
## Contribution
**All help is greatly welcomed!**
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!)_
Translations are also greatly appreciated.
See [CONTRIBUTING.md](CONTRIBUTING.md) for code or translation details and tips.
<!-- ---------- 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.