diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7580afc..2b74506 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,11 @@ Bug reports should include how to reproduce said bug, if known. - If your changes are not complete but e.g. you want feedback on your idea before fully committing to it, open a draft PR. - Otherwise, feel free to open a regular PR. +**Important:** Open PRs to the `main` branch only if your changes do not introduce incompatibilities with the latest +release of `egui_dock`, a.k.a. breaking changes. All breaking changes should be merged into a special `release-0.XYZ` +branch instead. This is to make it possible to release non-breaking bugfixes without requiring to update to a new incompatible +release. + Before your PR is merged, it needs to be approved by one of the maintainers. To minimize the review time, make sure all the following requirements are met: diff --git a/Cargo.toml b/Cargo.toml index ecc5c9f..c3a077a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "egui_dock" description = "Docking support for `egui` - an immediate-mode GUI library for Rust" authors = ["lain-dono", "Adam Gąsior (Adanos020)"] -version = "0.3.1" +version = "0.4.0" edition = "2021" rust-version = "1.65" license = "MIT" diff --git a/README.md b/README.md index 90900fc..760fca9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # `egui_dock`: docking support for [egui](https://github.com/emilk/egui) -[![egui_ver](https://img.shields.io/badge/egui-0.20-blue)](https://github.com/emilk/egui) +[![egui_ver](https://img.shields.io/badge/egui-0.21-blue)](https://github.com/emilk/egui) [![Crates.io](https://img.shields.io/crates/v/egui_dock)](https://crates.io/crates/egui_dock) [![docs.rs](https://img.shields.io/docsrs/egui_dock)](https://docs.rs/egui_dock/) @@ -15,15 +15,14 @@ Before contributing, please read [the contribution guide](CONTRIBUTING.md). ## Quick start -Add `egui_dock` to your project's dependencies. +Add `egui` and `egui_dock` to your project's dependencies. ```toml [dependencies] -egui_dock = "0.3" +egui = "0.21" +egui_dock = "0.4" ``` -Instead of explicitly depending on `egui`, prefer using `egui_dock::egui` since it's the compatible version. - Then proceed by setting up `egui`, following its [quick start guide](https://github.com/emilk/egui#quick-start). Once that's done, you can start using `egui_dock` – more details on that can be found in the [documentation](https://docs.rs/egui_dock/latest/egui_dock/).