mirror of
https://github.com/kunkunsh/kunkun.git
synced 2025-04-11 17:29:44 +00:00
Update Readme Layout (#118)
* 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
This commit is contained in:
parent
a359c8b739
commit
b866967dda
56
README.md
56
README.md
@ -1,35 +1,49 @@
|
|||||||

|

|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
> This project is still in the early stages of development.
|
> 🚧 Work in Progress 🚧
|
||||||
> There are known compatibility issues with Linux.
|
> This project is still in its early stages.
|
||||||
> Author is working on fixing them.
|
>
|
||||||
|
> 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.
|
||||||
## Demo Video and Instructions
|
>
|
||||||
|
> Got feedback or found a bug? Open an issue—it helps more than you know.
|
||||||
- YouTube: https://youtu.be/HfQb38s8VjY
|
|
||||||
- Download extension from https://kunkun.sh/download
|
|
||||||
|
|
||||||

|

|
||||||
[![YouTube badge][]][YouTube link]
|
[![YouTube badge][]][YouTube link]
|
||||||
[](https://discord.gg/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 badge]: https://img.shields.io/youtube/channel/subscribers/UC1gJeFbvRcQXDC_C8nKetdA?style=social
|
||||||
[YouTube link]: https://www.youtube.com/@huakun
|
[YouTube link]: https://www.youtube.com/@huakun
|
||||||
|
|
||||||
## Download
|
<table>
|
||||||
|
<tr>
|
||||||
- From the Website: https://kunkun.sh/download/
|
<th>Demo Video and Instructions</th>
|
||||||
- From GitHub Releases: https://github.com/kunkunsh/kunkun/releases
|
<th>Download</th>
|
||||||
|
<th>Platforms</th>
|
||||||
## Platforms
|
</tr>
|
||||||
|
<tr>
|
||||||
- [x] MacOS
|
<td>
|
||||||
- [x] Linux
|
<ul>
|
||||||
- [x] Windows
|
<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
|
## Star History
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user