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

Readme changes (#155)

Notable (proposed) changes:
- added two new captures to the readme (7-modules and 8-settings.png)
- moved contributors to a dedicated section
- change in the display of screenshots, for more flexibility in the
display resolution of the readme
- added details in the presentation text
- some other slight modifications...

Co-authored-by: TrianguloY <correo--correo@hotmail.com>
This commit is contained in:
Ilithy 2022-12-12 23:56:25 +01:00 committed by GitHub
parent b6d94eeb29
commit 2f9c50d144
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 34 deletions

View File

@ -6,17 +6,14 @@
# URLCheck
### Android app made by [TrianguloY](https://github.com/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, [404potato](https://github.com/404potato)
</div>
<br>
<!-- ---------- Badges ---------- -->
<div align="center">
[![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)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/TrianguloY/UrlChecker)](https://github.com/TrianguloY/UrlChecker/pulse/monthly) \
[![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)
@ -42,44 +39,46 @@ height="80">](https://play.google.com/store/apps/details?id=com.trianguloy.urlch
<!-- ---------- Description ---------- -->
<div align="center">
**URLCheck** 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...
**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...
</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 align="center">
<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>
<!-- ---------- Contribution ---------- -->
</div>
<!-- ---------- Contribution & contributors ---------- -->
## 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.
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.
### Contributors
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, [404potato](https://github.com/404potato)
<!-- ---------- License ---------- -->
## License
@ -96,5 +95,5 @@ You can use parts of this project in your own ones, or upload modified versions
**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.
- 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.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 47 KiB