docs: cleanup README

This commit is contained in:
swaits committed 2024-12-23 19:36:00 -07:00
1 parent 13ad9fab2f
commit b2e1997b56
1 file changed
+13 -15
+13 -15
View File
@@ -1,18 +1,17 @@
# universal-clipboard.nvim # universal-clipboard.nvim
A **minimal** Neovim plugin that automatically sets up sharing your **system 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, > **Platform Differences**: On macOS, Neovim appears to behave nicely with the
there’s `wl-copy`/`wl-paste` for Wayland or `xclip`/`xsel` for X11. > system `clipboard`. On others, not so much. External tools can help. For
2. **Missing `+clipboard`**: Many distro packages ship Neovim **without** > example, there’s `wl-copy`/`wl-paste`for Wayland or`xclip`/`xsel` for X11.
built-in clipboard support.
With **universal-clipboard.nvim**: With **universal-clipboard.nvim**:
- If Neovim **has** `+clipboard`, we simply use `unnamedplus`. - If we detect an external clipboard tool (`wl-clipboard`, `xclip`, `xsel`),
- If **not**, we detect which clipboard tool (`wl-clipboard`, `xclip`, `xsel`) we configure the `clipboard` to use it.
is available, and configure a fallback automatically. - Otherwise, we simply set it to `unnamedplus` with no further configuration.
## Installation ## 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 ### Default Options
```lua ```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 Once installed, **no additional steps** are needed. The plugin configures your
clipboard on startup. Simply copy and paste in Neovim as usual. 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 ### Commands
- `:UniversalClipboardCheck` - Shows whether Neovim has `+clipboard` and the - `:UniversalClipboardCheck` - Shows the current `clipboard` configuration.
current fallback configuration, if any. - `:UniversalClipboardReinit` - Re-runs detection. You **do not normally need to
- `:UniversalClipboardReinit` - Re-runs detection. You **do not need to run run this.** It's run automatically on startup.
this.** It's run automatically on startup.
## License ## License