From b866967dda0ac2ef43ae89a04d560cd423e482f9 Mon Sep 17 00:00:00 2001 From: Huakun Shen Date: Fri, 14 Feb 2025 20:49:00 -0500 Subject: [PATCH] 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 --- README.md | 56 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fa09b22..d562e57 100644 --- a/README.md +++ b/README.md @@ -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 + + + + + + + + + + + +
Demo Video and InstructionsDownloadPlatforms
+ + + + +
    +
  • MacOS
  • +
  • Linux
  • +
  • Windows
  • +
+
## Star History