waydeer/layer-shika
1
0
Fork 0
mirror of https://codeberg.org/waydeer/layer-shika.git synced 2025-12-12 14:25:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: update readme

Browse source
This commit is contained in:
drendog 2025-12-11 18:27:12 +01:00
parent eee1a92532
commit f8cb683586
Signed by: dwenya
GPG key ID: 8DD77074645332D0
1 changed files with 17 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -6,11 +6,13 @@
<p><b><a href="https://codeberg.org/waydeer/layer-shika">Main repo</a> | <a href="https://git.dren.dog/waydeer/layer-shika">Mirror</a> | <a href="https://github.com/waydeerwm/layer-shika">Temp mirror (github)</a></b></p> <p><b><a href="https://codeberg.org/waydeer/layer-shika">Main repo</a> | <a href="https://git.dren.dog/waydeer/layer-shika">Mirror</a> | <a href="https://github.com/waydeerwm/layer-shika">Temp mirror (github)</a></b></p>
</div> </div>
## ⚠️ WORK IN PROGRESS ⚠️
Oh deer! 🦌 You've stumbled upon `layer-shika`, a Rust library providing Wayland layer shell integration with Slint UI. Create overlay windows, status bars, panels, popups, and more, that integrate seamlessly with Wayland compositors. Oh deer! 🦌 You've stumbled upon `layer-shika`, a Rust library providing Wayland layer shell integration with Slint UI. Create overlay windows, status bars, panels, popups, and more, that integrate seamlessly with Wayland compositors.
Please note that this library is currently in early development and is not yet ready for production use. > [!CAUTION]
> This library is currently in early development and is not yet ready for production use. API may change before 1.0.
> [!NOTE]
> **Coming soon:** A complete Wayland shell built on top of layer-shika! Stay tuned for updates.
## Features ## Features
@ -46,13 +48,14 @@ This clean-like architecture enables flexibility, and clear dependency boundarie
- Custom event loop integration (timers, channels, file descriptors) - Custom event loop integration (timers, channels, file descriptors)
- HiDPI scale factor support - HiDPI scale factor support
**Known Limitations:** > [!WARNING]
> **Known Limitations:**
- API may change before 1.0 >
- Documentation is work in progress > - Documentation is work in progress
- Some edge cases may not be fully tested > - Some edge cases may not be fully tested
> - It's recommended to wait for a stable release before using this library in production projects
It's recommended to wait for a stable release before using this library in production projects, but if you want you can experiment with the current version. Development is trying to be as fast as a running skippy deer! >
> However, if you want to experiment with the current version, feel free to do so! Development is trying to be as fast as a running skippy deer!
## Quick Start ## Quick Start
@ -71,7 +74,8 @@ See the [examples README](examples/README.md) for detailed usage instructions an
## Usage ## Usage
If you want to use it now, use this repo as dependency instead of crates.io outdated versions. > [!IMPORTANT]
> If you want to use it now, use this repo as a dependency instead of crates.io versions.
## First Stable Release ## First Stable Release
@ -81,4 +85,5 @@ Stay tuned!
## Contributing ## Contributing
As the library is in a very early stage, it's recommended to open an issue to discuss ideas or proposed changes before submitting contributions. The project doesn't bite, it's not that kind of deer! > [!TIP]
> As the library is in a very early stage, it's recommended to open an issue to discuss ideas or proposed changes before submitting contributions. The project doesn't bite, it's not that kind of deer!