diff --git a/README.md b/README.md index 2860a02..75d87b3 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,15 @@ All heavy work (hashing, decoding, storage, search, thumbnails) lives in a Rust daemon. The GNOME Shell extension only renders UI and forwards events over D-Bus, so the compositor is never blocked, even with thousands of items. +

+ + Get it on GNOME Extensions + +

+ +> **Requires a companion daemon.** Installing from GNOME Extensions is only half +> the setup. See [Installing the daemon](#installing-the-daemon). + The motivation behind this is explained in the technical blog post [Rethinking the GNOME clipboard issues](https://edu4rdshl.dev/posts/rethinking-the-gnome-clipboard-issues/) ## Features @@ -104,6 +113,32 @@ GNOME Shell (GJS) ──D-Bus──▶ strata-daemon ──▶ SQLite (~/.lo └──▶ thumbnails (~/.cache/strata) ``` +## Installing the daemon + +Strata is two parts: the GNOME Shell extension and a small background daemon +(`strata-daemon`) that does the storage, search, and thumbnailing. Installing +the extension from [GNOME Extensions](https://extensions.gnome.org/extension/10291/strata/) +is only half the setup; **without the daemon the extension does nothing.** + +Install the daemon with whichever fits your system: + +- **Arch (AUR):** `paru -S strata-daemon` (or `strata-daemon-git` for the latest `main`). +- **From source:** + + ```sh + git clone https://github.com/Edu4rdSHL/Strata.git + cd Strata + make install-daemon # builds and installs to ~/.local/bin + ``` + + Make sure `~/.local/bin` is in your `$PATH`. + +Then log out and back in (Wayland) or `Alt+F2` → `r` (X11). The extension finds +`strata-daemon` in `$PATH` and starts it automatically; no separate service is +needed. + +For distro packages and the systemd user service, see [Install](#install). + ## Requirements - GNOME Shell 50. Older releases may work if built from source but are not tested or supported.