From f2e64940ae88190a5eccb2d740aa06798a5774b1 Mon Sep 17 00:00:00 2001
From: Vaxry <43317083+vaxerski@users.noreply.github.com>
Date: Sat, 3 Dec 2022 20:47:58 +0000
Subject: [PATCH] updated readme

---
 README.md | 60 +++++++------------------------------------------------
 1 file changed, 7 insertions(+), 53 deletions(-)

diff --git a/README.md b/README.md
index 48dc996..28abebb 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
-# xdg-desktop-portal-wlr
+# xdg-desktop-portal-hyprland
 
-[![builds.sr.ht status](https://builds.sr.ht/~emersion/xdg-desktop-portal-wlr/commits/master.svg)](https://builds.sr.ht/~emersion/xdg-desktop-portal-wlr/commits/master?)
+[xdg-desktop-portal] backend for hyprland
 
-[xdg-desktop-portal] backend for wlroots
+## What and why?
+Due to reasons explained in [hyprland-protocols](https://github.com/hyprwm/hyprland-protocols),
+we have a separate desktop portal impl for Hyprland.
+
+Although `-wlr` **does** work with Hyprland, `-hyprland` offers more features.
 
 ## Building
 
@@ -19,58 +23,8 @@ ninja -C build
 ninja -C build install
 ```
 
-### Distro Packages
-
-[![Packaging status](https://repology.org/badge/vertical-allrepos/xdg-desktop-portal-wlr.svg)](https://repology.org/project/xdg-desktop-portal-wlr/versions)
-
-
-## Running
-
-Make sure `XDG_CURRENT_DESKTOP` is set. Make sure `WAYLAND_DISPLAY` and
-`XDG_CURRENT_DESKTOP` are imported into D-Bus. If you're running Sway, this
-can be added to your config file:
-
-    exec dbus-update-activation-environment --systemd WAYLAND_DISPLAY XDG_CURRENT_DESKTOP=sway
-
-When correctly installed, xdg-desktop-portal should automatically invoke
-xdg-desktop-portal-wlr when needed.
-
-### Configuration
-
-See `man 5 xdg-desktop-portal-wlr`.
-
-### Manual startup
-
-At the moment, some command line flags are available for development and
-testing. If you need to use one of these flags, you can start an instance of
-xdpw using the following command:
-
-```sh
-xdg-desktop-portal-wlr -r [OPTION...]
-```
-
-To list the available options, you can run `xdg-desktop-portal-wlr --help`.
-
-## FAQ
-
-Check out or [FAQ] for answers to commonly asked questions.
-
-Please see the [screencast compatibility] guide for more information on
-compatible applications and how to get them working.
-
-If you have a question or problem that is not mentioned in those documents,
-please open an issue or come chat with us in #sway on Libera Chat.
-
-## Contributing
-
-If you're interested in testing or development, check out
-[CONTRIBUTING.md] for more information.
-
 ## License
-
 MIT
 
 [xdg-desktop-portal]: https://github.com/flatpak/xdg-desktop-portal
-[FAQ]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/FAQ
 [screencast compatibility]: https://github.com/emersion/xdg-desktop-portal-wlr/wiki/Screencast-Compatibility
-[CONTRIBUTING.md]: CONTRIBUTING.md