outfoxxed
/
quickshell
1
1
Fork 2
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add breaking change notice

This commit is contained in:
outfoxxed 2024-07-01 20:50:07 -07:00
parent d8b900ed0b
commit c31bbea837
Signed by: outfoxxed
GPG Key ID: 4C88A185FB89301E
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,7 +1,7 @@
# quickshell
<a href="https://matrix.to/#/#quickshell:outfoxxed.me"><img src="https://img.shields.io/badge/Join%20the%20matrix%20room-%23quickshell:outfoxxed.me-0dbd8b?logo=matrix&style=flat-square"></a>
Simple and flexbile QtQuick based desktop shell toolkit.
Flexbile QtQuick based desktop shell toolkit.
Hosted on: [outfoxxed's gitea], [github]
@ -14,6 +14,12 @@ can be built from the [quickshell-docs](https://git.outfoxxed.me/outfoxxed/quick
Some fully working examples can be found in the [quickshell-examples](https://git.outfoxxed.me/outfoxxed/quickshell-examples)
repo.
# Breaking Changes
Quickshell is still in alpha and there will be breaking changes.
Commits with breaking qml api changes will contain a `!` at the end of the scope
(`thing!: foo`) and the commit description will contain details about the broken api.
# Installation
## Nix