diff --git a/README.md b/README.md index 99c3a60..0cc3d1b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # quickshell -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