From b2e1997b56423c87b5f9fa2b2265d6d273af9c5e Mon Sep 17 00:00:00 2001 From: Stephen Waits Date: Mon, 23 Dec 2024 19:29:07 -0700 Subject: [PATCH] docs: cleanup README --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b55a83e..f44303b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ # universal-clipboard.nvim A **minimal** Neovim plugin that automatically sets up sharing your **system -clipboard** across multiple platforms. It addresses two common issues: +clipboard** across multiple platforms. It addresses this issue: -1. **Platform Differences**: On macOS, `pbcopy/pbpaste` is native; on Linux, - there’s `wl-copy`/`wl-paste` for Wayland or `xclip`/`xsel` for X11. -2. **Missing `+clipboard`**: Many distro packages ship Neovim **without** - built-in clipboard support. +> **Platform Differences**: On macOS, Neovim appears to behave nicely with the +> system `clipboard`. On others, not so much. External tools can help. For +> example, there’s `wl-copy`/`wl-paste`for Wayland or`xclip`/`xsel` for X11. With **universal-clipboard.nvim**: -- If Neovim **has** `+clipboard`, we simply use `unnamedplus`. -- If **not**, we detect which clipboard tool (`wl-clipboard`, `xclip`, `xsel`) - is available, and configure a fallback automatically. +- If we detect an external clipboard tool (`wl-clipboard`, `xclip`, `xsel`), + we configure the `clipboard` to use it. +- Otherwise, we simply set it to `unnamedplus` with no further configuration. ## Installation @@ -40,6 +39,9 @@ Or [**lazy.nvim**](https://github.com/folke/lazy.nvim): } ``` +> **Note:** If your Neovim lacks `+clipboard`, make sure you have at least one +> of `wl-clipboard`, `xclip`, or `xsel` is installed. + ### Default Options ```lua @@ -54,15 +56,11 @@ Or [**lazy.nvim**](https://github.com/folke/lazy.nvim): Once installed, **no additional steps** are needed. The plugin configures your clipboard on startup. Simply copy and paste in Neovim as usual. -> **Note:** If your Neovim lacks `+clipboard`, make sure you have at least one -> of `wl-clipboard`, `xclip`, or `xsel` is installed. - ### Commands -- `:UniversalClipboardCheck` - Shows whether Neovim has `+clipboard` and the - current fallback configuration, if any. -- `:UniversalClipboardReinit` - Re-runs detection. You **do not need to run - this.** It's run automatically on startup. +- `:UniversalClipboardCheck` - Shows the current `clipboard` configuration. +- `:UniversalClipboardReinit` - Re-runs detection. You **do not normally need to + run this.** It's run automatically on startup. ## License