Update readme

README.md

@@ -1,50 +1,38 @@
-# GTK4 version of GTK Layer Shell -- WIP
-It works, but it's still rough around the edges. See the end of https://github.com/wmww/gtk-layer-shell/issues/37 for details.
+# GTK4 Layer Shell
 
-TODO before release:
-- fix docs building in CI
-- fix margin crash in demo
-- detect if library got properly loaded and warn otherwise
-- test with standalone project
-- update vala example
-- update python example
-- update release process document
-- update readme on this repo
-- update readme on GTK3 repo
+![GTK4 Layer Demo screenshot](https://i.imgur.com/dR8X15i.png)
 
-# GTK Layer Shell
+A library for using the [Layer Shell](https://gitlab.freedesktop.org/wlroots/wlr-protocols/-/blob/master/unstable/wlr-layer-shell-unstable-v1.xml) Wayland protocol with [GTK4](https://www.gtk.org/). With this library you can build desktop shell components such as panels, notifications and wallpapers. You can use it to anchor your windows to a corner or edge of the output, or stretch them across the entire output. This Library is compatible with C, C++ and any language that supports GObject introspection files (Python, Vala, etc).
 
-![GTK Layer Shell demo screenshot](https://i.imgur.com/dIuYcBM.png)
+[Documentation](https://wmww.github.io/gtk4-layer-shell/)
 
-A library to write [GTK](https://www.gtk.org/) applications that use [Layer Shell](https://github.com/swaywm/wlr-protocols/blob/master/unstable/wlr-layer-shell-unstable-v1.xml). Layer Shell is a Wayland protocol for desktop shell components, such as panels, notifications and wallpapers. You can use it to anchor your windows to a corner or edge of the output, or stretch them across the entire output. It supports all Layer Shell features including popups and popovers (GTK popups Just Work™). This Library is compatible with C, C++ and any language that supports GObject introspection files (Python, Vala, etc, see using the library below).
+[GTK3 version](https://github.com/wmww/gtk-layer-shell)
 
 ## Supported Desktops
 This library only works on Wayland, and only on Wayland compositors that support the Layer Shell protocol. Layer shell __is supported__ on:
 - wlroots based compositors (such as __Sway__)
-- Mir-based compositors (some may not enable the protocol by default and require `--add-wayland-extension zwlr_layer_shell_v1`)
+- __KDE Plasma__ on wayland
+- __Mir__-based compositors (some may not enable the protocol by default. It can be enabled with `--add-wayland-extension zwlr_layer_shell_v1`)
 
 Layer shell __is not supported__ on:
 - Gnome-on-Wayland
 - Any X11 desktop
 
 ## Using the Library
 ### Demo
-`gtk-layer-demo` is built if examples are enabled. Its UI exposes all features of the library, and it's useful for testing layer shell support in compositors. Its code can be found in [examples/demo/](examples/demo/).
+`gtk-layer-demo` is built if examples are enabled. It's useful for testing layer shell support in compositors. Its code can be found in [examples/demo/](examples/demo/).
 
 ### C/C++
-The easiest way to build against GTK Layer Shell is to use the `gtk-layer-shell-0` pkg-config package. Refer to your build system or the pkg-config docs for further instructions. [gtk-layer-shell.h](include/gtk-layer-shell.h) shows the full API, which can be used directly in C or C++. [examples/simple-example.c](examples/simple-example.c) is a minimal complete app written in C.
+The easiest way to build against GTK Layer Shell is to use the `gtk-layer-shell-0` pkg-config package. Refer to your build system or the pkg-config docs for further instructions. [examples/simple-example.c](examples/simple-example.c) is a minimal complete app written in C. __If you link against libwayland, you must link libwayland after gtk4-layer-shell__. See [linking.md](linking.md) for details.
 
 ### Python
 [examples/simple-example.py](examples/simple-example.py) contains sample Python code.
 
 ### Vala
 [examples/vala-standalone](examples/vala-standalone) contains a minimal working standalone Vala project, see [the readme](examples/vala-standalone/README.md) for details.
 
-### Rust
-[@pentamassiv](https://github.com/pentamassiv) maintains [safe Rust bindings](https://github.com/pentamassiv/gtk-layer-shell-gir) and the [crates.io crate](https://crates.io/crates/gtk-layer-shell/). Rust examples can be found [here](https://github.com/pentamassiv/gtk-layer-shell-gir/tree/main/gtk-layer-shell/examples).
-
 ## Distro Packages
-[![List of distros GTK Layer Shell is packaged for](https://repology.org/badge/vertical-allrepos/gtk-layer-shell.svg)](https://repology.org/project/gtk-layer-shell/versions)
+[![List of distros GTK Layer Shell is packaged for](https://repology.org/badge/vertical-allrepos/gtk4-layer-shell.svg)](https://repology.org/project/gtk4-layer-shell/versions)
 
 ## Building From Source
 1. Clone this repo
@@ -57,14 +45,14 @@ The easiest way to build against GTK Layer Shell is to use the `gtk-layer-shell-
 ### Build Dependencies
 * [Meson](https://mesonbuild.com/) (>=0.45.1)
 * [libwayland](https://gitlab.freedesktop.org/wayland/wayland) (>=1.10.0)
-* [GTK3](https://www.gtk.org/) (>=3.22.0)
+* [GTK4](https://www.gtk.org/)
 * [GObject introspection](https://gitlab.gnome.org/GNOME/gobject-introspection/)
 * [GTK Doc](https://www.gtk.org/gtk-doc/) (only required if docs are enabled)
 * [Vala](https://wiki.gnome.org/Projects/Vala) (only required if vapi is enabled)
 
 To install these dependencies on Ubuntu 18.04 and later:
 ```
-sudo apt install meson libwayland-dev libgtk-3-dev gobject-introspection libgirepository1.0-dev gtk-doc-tools valac
+sudo apt install meson libwayland-dev libgtk-4-dev gobject-introspection libgirepository1.0-dev gtk-doc-tools valac
 ```
 
 ### Meson Options