Skip to content

Commit 26aa126

Browse files
authored
Modernize README (#139)
* Prepare new Readme * Modernize README * Tweak wording
1 parent e4a6565 commit 26aa126

File tree

3 files changed

+96
-71
lines changed

3 files changed

+96
-71
lines changed

.github/assets/logo.png

7.46 KB
Loading

.github/readme-images/app-icon.png

-736 Bytes
Binary file not shown.

README.md

+96-71
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,114 @@
1-
| Build | Stable | Weekly Beta | Support Server |
2-
|-------|--------|-------------|----------------|
3-
| [![CI](https://github.com/mihonapp/mihon/actions/workflows/build_push.yml/badge.svg)](https://github.com/mihonapp/mihon/actions/workflows/build_push.yml) | [![stable release](https://img.shields.io/github/release/mihonapp/mihon.svg?maxAge=3600&label=download)](https://github.com/mihonapp/mihon/releases) | [![latest beta build](https://img.shields.io/github/v/release/mihonapp/mihon-preview.svg?maxAge=3600&label=download)](https://github.com/mihonapp/mihon-preview/releases) | [![Discord](https://img.shields.io/discord/1195734228319617024.svg?label=discord&labelColor=7289da&color=2c2f33&style=flat)](https://discord.gg/mihon) |
4-
5-
# ![app icon](./.github/readme-images/app-icon.png)Mihon
6-
Mihon is a free and open source manga reader for Android 8.0 and above.
7-
8-
## Features
9-
10-
Features include:
11-
* Online reading from a variety of sources
12-
* Local reading of downloaded content
13-
* A configurable reader with multiple viewers, reading directions and other settings.
14-
* Tracker support: [MyAnimeList](https://myanimelist.net/), [AniList](https://anilist.co/), [Kitsu](https://kitsu.io/), [MangaUpdates](https://mangaupdates.com), [Shikimori](https://shikimori.one), and [Bangumi](https://bgm.tv/) support
15-
* Categories to organize your library
16-
* Light and dark themes
17-
* Schedule updating your library for new chapters
18-
* Create backups locally to read offline or to your desired cloud service
19-
20-
## Download
21-
Get the app from our [releases page](https://github.com/mihonapp/mihon/releases).
22-
23-
If you want to try new features before they get to the stable release, you can download the beta version [here](https://github.com/mihonapp/mihon-preview/releases).
24-
25-
## Issues, Feature Requests and Contributing
26-
27-
Please make sure to read the full guidelines. Your issue may be closed without warning if you do not.
28-
29-
<details><summary>Issues</summary>
30-
31-
1. **Before reporting a new issue, take a look at the [FAQ](https://mihon.app/docs/faq/general), the [changelog](https://mihon.app/changelogs/) and the already opened [issues](https://github.com/mihonapp/mihon/issues).**
32-
2. If you are unsure, ask here: [![Discord](https://img.shields.io/discord/1195734228319617024.svg)](https://discord.gg/mihon)
1+
<p align="center">
2+
<br>
3+
<a href="https://mihon.app">
4+
<img src="./.github/assets/logo.png" width="90"/>
5+
</a>
6+
</p>
7+
8+
<h1 align="center">Mihon <a href="#">App</a></h1>
9+
<h3 align="center">Full-featured reader</h3>
10+
<p align="center">Discover and read manga, webtoons, comics, and more – easier than ever on your Android device.</p>
11+
12+
<p align="center">
13+
<a title="Discord server" href="https://discord.gg/mihon">
14+
<img src="https://img.shields.io/discord/1195734228319617024.svg?label=&labelColor=6A7EC2&color=7389D8&logo=discord&logoColor=FFFFFF">
15+
</a>
16+
<a title="GitHub downloads" href="https://github.com/mihonapp/mihon/releases">
17+
<img src="https://img.shields.io/github/downloads/mihonapp/mihon/total?label=downloads&labelColor=27303D&color=0D1117&logo=github&logoColor=FFFFFF&style=flat">
18+
</a>
19+
<br>
20+
<a title="CI" href="https://github.com/mihonapp/mihon/actions/workflows/build_push.yml">
21+
<img src="https://github.com/mihonapp/mihon/actions/workflows/build_push.yml/badge.svg">
22+
</a>
23+
</p>
24+
25+
<h2 align="center">Download</h2>
26+
27+
<p align="center">
28+
<a title="Stable" href="https://github.com/mihonapp/mihon/releases">
29+
<img src="https://img.shields.io/github/release/mihonapp/mihon.svg?maxAge=3600&label=Stable&labelColor=06599d&color=043b69">
30+
</a>
31+
<a title="Beta" href="https://github.com/mihonapp/mihon-preview/releases">
32+
<img src="https://img.shields.io/github/v/release/mihonapp/mihon-preview.svg?maxAge=3600&label=Beta&labelColor=2c2c47&color=1c1c39 ">
33+
</a>
34+
<br>
35+
<em>Requires Android 8.0 or higher.</em>
36+
</p>
37+
38+
<h2 align="center">Features</h2>
39+
40+
<h3>Features include</h3>
41+
<ul>
42+
<li>Local reading of content</li>
43+
<li>A configurable reader with multiple viewers, reading directions and other settings.</li>
44+
<li>Tracker support: <a target="_blank" href="https://myanimelist.net/">MyAnimeList</a>, <a target="_blank" href="https://anilist.co/">AniList</a>, <a target="_blank" href="https://kitsu.io/">Kitsu</a>, <a target="_blank" href="https://mangaupdates.com">MangaUpdates</a>, <a target="_blank" href="https://shikimori.one">Shikimori</a>, and <a target="_blank" href="https://bgm.tv/">Bangumi</a> support</li>
45+
<li>Categories to organize your library</li>
46+
<li>Light and dark themes</li>
47+
<li>Schedule updating your library for new chapters</li>
48+
<li>Create backups locally to read offline or to your desired cloud service</li>
49+
<li>and much more...</li>
50+
<ul>
51+
52+
<h2 align="center">Contributing</h2>
53+
54+
<p align="center">
55+
<a href="./CODE_OF_CONDUCT.md">Code of conduct</a>
56+
·
57+
<a href="./CONTRIBUTING.md">Contributing guide</a>
58+
·
59+
</p>
60+
61+
<p align="center">Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.</p>
62+
<p align="center">If you got any questions, join our <a target="_blank" href="https://discord.gg/mihon">Discord server</a>.</p>
63+
64+
<details align="center"><summary>Issues</summary>
65+
66+
1. <strong>Before reporting a new issue, take a look at the <a href="https://mihon.app/docs/faq/general">FAQ</a>, the <a href="https://mihon.app/changelogs/">changelog</a> and the already opened <a href="https://github.com/mihonapp/mihon/issues">issues</a>.</strong>
67+
2. If you are unsure, ask here: <a href="https://discord.gg/mihon"><img src="https://img.shields.io/discord/1195734228319617024.svg" alt="Discord"></a>
3368

3469
</details>
3570

36-
<details><summary>Bugs</summary>
71+
<details align="center"><summary>Bugs</summary>
3772

38-
* Include version (More → About → Version)
39-
* If not latest, try updating, it may have already been solved
40-
* Beta version is equal to the number of commits as seen on the main page
41-
* Include steps to reproduce (if not obvious from description)
42-
* Include screenshot (if needed)
43-
* If it could be device-dependent, try reproducing on another device (if possible)
44-
* Don't group unrelated requests into one issue
73+
<em> Include version (More → About → Version)
74+
</em> If not latest, try updating, it may have already been solved
75+
<em> Beta version is equal to the number of commits as seen on the main page
76+
</em> Include steps to reproduce (if not obvious from description)
77+
<em> Include screenshot (if needed)
78+
</em> If it could be device-dependent, try reproducing on another device (if possible)
4579

46-
</details>
47-
48-
<details><summary>Feature Requests</summary>
49-
50-
* Write a detailed issue, explaining what it should do or how. Avoid writing just "like X app does"
51-
* Include screenshot (if needed)
80+
- Don&#39;t group unrelated requests into one issue
5281

53-
Source requests are not accepted.
5482
</details>
5583

56-
<details><summary>Contributing</summary>
84+
<details align="center"><summary>Feature requests</summary>
5785

58-
See [CONTRIBUTING.md](./CONTRIBUTING.md).
59-
</details>
86+
<em> Write a detailed issue, explaining what it should do or how. Avoid writing just &quot;like X app does&quot;
87+
</em> Include screenshot (if needed)
6088

61-
<details><summary>Code of Conduct</summary>
89+
Source requests are not accepted.
6290

63-
See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).
6491
</details>
6592

66-
## FAQ
67-
68-
[See our website.](https://mihon.app/)
69-
You can also reach out to us on [Discord](https://discord.gg/mihon).
70-
71-
## License
72-
73-
Copyright 2015 Javier Tomás
93+
<h3 align="center">Repositories</h3>
7494

75-
Licensed under the Apache License, Version 2.0 (the "License");
76-
you may not use this file except in compliance with the License.
77-
You may obtain a copy of the License at
95+
<div>
96+
<p align="center">
97+
<a href="https://github.com/mihonapp/website/">
98+
<img src="https://github-readme-stats.vercel.app/api/pin/?username=mihonapp&repo=website&bg_color=161B22&text_color=c9d1d9&title_color=818CF8&icon_color=818CF8&border_radius=8&hide_border=true" alt="Website">
99+
</a>
100+
</p>
101+
</div>
78102

79-
http://www.apache.org/licenses/LICENSE-2.0
103+
<h3 align="center">License</h3>
80104

81-
Unless required by applicable law or agreed to in writing, software
82-
distributed under the License is distributed on an "AS IS" BASIS,
83-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
84-
See the License for the specific language governing permissions and
85-
limitations under the License.
105+
<pre align="center">Copyright © 2024 The Mihon Open Source Project<br><br>This Source Code Form is subject to the terms of the Mozilla Public<br>License, v. 2.0. If a copy of the MPL was not distributed with this<br>file, You can obtain one at http://mozilla.org/MPL/2.0/.</pre>
86106

87-
## Disclaimer
107+
<h3 align="center">Credits</h3>
88108

89-
The developer of this application does not have any affiliation with the content providers available.
109+
<p align="center">Thank you to all the people who have already contributed!</p>
110+
<p align="right">
111+
<a href="https://github.com/mihonapp/mihon/graphs/contributors">
112+
<img src="https://contrib.rocks/image?repo=mihonapp/mihon" width="800"/>
113+
</a>
114+
</p>

0 commit comments

Comments
 (0)