Skip to content

Commit 8978764

Browse files
committed
nicer readme
1 parent b5fa3ef commit 8978764

File tree

1 file changed

+51
-35
lines changed

1 file changed

+51
-35
lines changed

README.md

+51-35
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,73 @@
1-
<h1 align="center"> Quacker </h1> <br>
1+
<h1 align="center">Quacker</h1>
22
<p align="center">
3-
<a href="https://github.com/thehcj/quacker">
4-
<img alt="Quacker" title="Quacker" src="assets/icon.png" width="144" style="border-radius: 50%;">
5-
</a>
6-
</p>
7-
<p align="center">
8-
A private and clean way to browse X
3+
<img src="assets/icon.png" alt="Quacker Logo" width="144">
94
</p>
105

6+
<p align="center">A private and clean way to browse Twitter/X</p>
7+
118
<p align="center">
129
<a href="https://f-droid.org/en/packages/com.thehcj.quacker/">
13-
<img alt="Get it on F-Droid" src="https://f-droid.org/badge/get-it-on.png" height="80"></a>
10+
<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" height="80">
11+
</a>
1412
<a href="https://github.com/TheHCJ/Quacker/releases">
15-
<img alt="Get it on GitHub" src="assets/readme/get-it-on-github.png" height="80"></a>
13+
<img src="assets/readme/get-it-on-github.png" alt="Get it on GitHub" height="80">
14+
</a>
1615
</p>
1716

1817
<p align="center">
19-
<a href="https://github.com/TheHCJ/Quacker/releases" alt="GitHub release"><img src="https://img.shields.io/github/release/TheHCJ/Quacker.svg" ></a>
20-
<a href="https://f-droid.org/packages/com.thehcj.quacker/"><img alt="F-Droid Version" src="https://img.shields.io/f-droid/v/com.thehcj.quacker?label=release%20(f-droid)&color=green"></a>
21-
<a href="/LICENSE" alt="License: MIT"><img src="https://img.shields.io/badge/license-mit-E51400.svg"></a>
22-
<a href="https://github.com/TheHCJ/Quacker/actions" alt="Build Status"><img src="https://github.com/TheHCJ/Quacker/workflows/ci/badge.svg"></a>
23-
<a href="https://hosted.weblate.org/engage/quacker/" alt="Translation Status"><img src="https://hosted.weblate.org/widgets/quacker/-/svg-badge.svg"></a>
18+
<a href="https://github.com/TheHCJ/Quacker/releases" alt="GitHub release">
19+
<img src="https://img.shields.io/github/v/release/TheHCJ/Quacker?style=flat&logo=github&color=2dba4e
20+
" alt="GitHub release">
21+
</a>
22+
<a href="https://f-droid.org/packages/com.thehcj.quacker/">
23+
<img src="https://img.shields.io/f-droid/v/com.thehcj.quacker?logo=fdroid&color=%232278CF
24+
" alt="F-Droid Version">
25+
</a>
26+
<a href="/LICENSE" alt="License: MIT">
27+
<img src="https://img.shields.io/github/license/TheHCJ/Quacker?logo=opensourceinitiative&logoColor=FFFFFF&color=750014
28+
" alt="License: MIT">
29+
</a>
30+
<a href="https://github.com/TheHCJ/Quacker/actions" alt="Build Status">
31+
<img src="https://github.com/TheHCJ/Quacker/workflows/ci/badge.svg" alt="Build Status">
32+
</a>
33+
<a href="https://hosted.weblate.org/engage/quacker/" alt="Translation Status">
34+
<img src="https://hosted.weblate.org/widgets/quacker/-/svg-badge.svg" alt="Translation Status">
35+
</a>
2436
</p>
2537

2638
## Features:
27-
* Feed: View your `Following` and `For You` feeds
28-
* Material You: Looks and feels modern
29-
* Bookmarks: Save posts locally and offline
30-
* Trends: See what's trending in the world
31-
* Light and Dark themes: Protect your eyes
32-
* Subscriptions: Follow and group accounts
33-
* Polls: View results without needing to vote
34-
* Search: Find users and posts
35-
* And more!
39+
- **Feed:** View your `Following` and `For You` feeds
40+
- **Material You:** Looks and feels modern
41+
- **Bookmarks:** Save posts locally and offline
42+
- **Trends:** See what's trending in the world
43+
- **Light and Dark themes:** Protect your eyes
44+
- **Subscriptions:** Follow and group accounts
45+
- **Polls:** View results without needing to vote
46+
- **Search:** Find users and posts
47+
- **And more!**
3648

3749
## Screenshots
3850

39-
| <img alt="Viewing subscriptions" src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.jpg" width="218"/> | <img alt="Viewing a profile" src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.jpg" width="218"/> | <img alt="Tweet cards" src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.jpg" width="218"/> | <img alt="Viewing trends" src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.jpg" width="218"/> |
51+
| Viewing subscriptions | Viewing a profile | Tweet cards | Viewing trends |
52+
|:----------------------:|:-----------------:|:-----------:|:--------------:|
53+
| <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.jpg" alt="Viewing subscriptions" width="218"/> | <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.jpg" alt="Viewing a profile" width="218"/> | <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.jpg" alt="Tweet cards" width="218"/> | <img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.jpg" alt="Viewing trends" width="218"/> |
4054

41-
## Contribute
42-
If you'd like to help make Quacker even better, here are a just a few of the ways you can help!
43-
44-
### Report a bug
45-
If you've found a bug in Quacker, open a [new issue](https://github.com/thehcj/quacker/issues/new/choose), but please make sure to check that someone else hasn't reported it first.
55+
## Community
56+
### Stargazers
57+
[![Stargazers repo roster for @TheHCJ/Quacker](https://reporoster.com/stars/TheHCJ/Quacker)](https://github.com/TheHCJ/Quacker/stargazers)
4658

47-
### Request a feature
48-
If you feel like something is missing from Quacker, feel free to [open an issue](https://github.com/thehcj/quacker/issues/new/choose) about it, detailing exactly what you're looking for. We'll look it over, discuss it with the community, and see if it'll work!
59+
### Forkers
60+
[![Forkers repo roster for @TheHCJ/Quacker](https://reporoster.com/forks/TheHCJ/Quacker)](https://github.com/TheHCJ/Quacker/network/members)
4961

50-
### Fix a bug
51-
If you're looking for something to dip your toes into the codebase, check if there are any issues labelled good first issue. Otherwise, if you see another issue you'd like to tackle, go for it - just fork the repository, push to a branch, and create a PR detailing your changes. We'll review it and merge it in, once it meets all our checks and balances!
62+
## Contribute
63+
If you'd like to help make Quacker even better, here are a few ways you can contribute:
5264

65+
- **Report a bug:** If you've found a bug in Quacker, open a [new issue](https://github.com/thehcj/quacker/issues/new/choose), but please make sure to check that someone else hasn't reported it first.
66+
- **Request a feature:** Feel like something is missing from Quacker? [Open an issue](https://github.com/thehcj/quacker/issues/new/choose) about it, detailing exactly what you're looking for.
67+
- **Fix a bug:** If you're looking to contribute to the codebase, check for issues labeled "good first issue". Otherwise, feel free to tackle any other issue, fork the repository, push to a branch, and create a pull request.
68+
5369
## Translations
5470

5571
You can help by translating the app into your preferred language(s)!
56-
1. You can use [Weblate](https://hosted.weblate.org/projects/quacker/quacker/) for translations **(RECOMMENDED)**
57-
2. You can use the [⚐ Translations](https://github.com/TheHCJ/Quacker/issues/new?assignees=&labels=needs+triage&projects=&template=--translations.md&title=%5BTRANSLATION%5D) issue template
72+
1. Use [Weblate](https://hosted.weblate.org/projects/quacker/quacker/) for translations **(RECOMMENDED)**
73+
2. Use the [⚐ Translations](https://github.com/TheHCJ/Quacker/issues/new?assignees=&labels=needs+triage&projects=&template=--translations.md&title=%5BTRANSLATION%5D) issue template

0 commit comments

Comments
 (0)