Skip to content

Commit

Permalink
Update Readme Layout (kunkunsh#118)
Browse files Browse the repository at this point in the history
* docs(readme): improve project documentation layout and warning section

* docs(readme): refactor layout with flexbox for improved readability

* docs(readme): simplify resource links and add platform section

* docs(readme): restructure platforms section

* docs(readme): replace flexbox with table for resource and platform sections
  • Loading branch information
HuakunShen authored Feb 15, 2025
1 parent a359c8b commit b866967
Showing 1 changed file with 35 additions and 21 deletions.
56 changes: 35 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,49 @@
![kunkun](https://socialify.git.ci/kunkunsh/kunkun/image?description=1&forks=1&issues=1&logo=https%3A%2F%2Fstorage.huakun.tech%2F2024%2F9%2F12%2F4MjHiKK.png&name=1&owner=1&pattern=Circuit%20Board&pulls=1&stargazers=1&theme=Auto)

> [!WARNING]
> This project is still in the early stages of development.
> There are known compatibility issues with Linux.
> Author is working on fixing them.
## Demo Video and Instructions

- YouTube: https://youtu.be/HfQb38s8VjY
- Download extension from https://kunkun.sh/download
> 🚧 Work in Progress 🚧
> This project is still in its early stages.
>
> We know it’s not perfect yet. The author is pouring heart, soul, and a few sleepless nights into fixing the issues. Your patience means everything.
>
> Got feedback or found a bug? Open an issue—it helps more than you know.
![GitHub last commit](https://img.shields.io/github/last-commit/kunkunsh/kunkun)
[![YouTube badge][]][YouTube link]
[![](https://dcbadge.limes.pink/api/server/7dzw3TYeTU)](https://discord.gg/7dzw3TYeTU)

- Website: https://kunkun.sh/
- Documentation: https://docs.kunkun.sh/

[YouTube badge]: https://img.shields.io/youtube/channel/subscribers/UC1gJeFbvRcQXDC_C8nKetdA?style=social
[YouTube link]: https://www.youtube.com/@huakun

## Download

- From the Website: https://kunkun.sh/download/
- From GitHub Releases: https://github.com/kunkunsh/kunkun/releases

## Platforms

- [x] MacOS
- [x] Linux
- [x] Windows
<table>
<tr>
<th>Demo Video and Instructions</th>
<th>Download</th>
<th>Platforms</th>
</tr>
<tr>
<td>
<ul>
<li><a href="https://youtu.be/HfQb38s8VjY">Introduction Video</a></li>
<li><a href="https://kunkun.sh/">Visit Website</a></li>
<li><a href="https://docs.kunkun.sh/">Documentation</a></li>
</ul>
</td>
<td>
<ul>
<li><a href="https://kunkun.sh/download/">From Website</a></li>
<li><a href="https://github.com/kunkunsh/kunkun/releases">From GitHub Releases</a></li>
</ul>
</td>
<td>
<ul>
<li>MacOS</li>
<li>Linux</li>
<li>Windows</li>
</ul>
</td>
</tr>
</table>

## Star History

Expand Down

0 comments on commit b866967

Please sign in to comment.