From 6fcb4e578eca295ef10e19ebbb56056dd6b99226 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20=C5=A0tefka?= Date: Fri, 19 Apr 2024 23:52:15 +0200 Subject: [PATCH] fix(docs): Update README to use my wiki, use Markdown Allerts (#54) --- README.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4eacd28..3954c2b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This repository uses - Cross-platform support: macOS, nixOS, Linux[\*](#notes), Windows, WSL - Startup time is fast(er than other Rich Presence plugins, by -[kind of a lot](https://github.com/andweeb/presence.nvim/wiki/Plugin-Comparisons)) +[kind of a lot](https://github.com/jiriks74/presence.nvim/wiki/Plugin-Comparisons)) - Written in Lua and [highly configurable](#configuration) in Lua (but also configurable in VimL if you want) - Manages Rich Presence across multiple Neovim instances in various environments @@ -27,6 +27,11 @@ Windows, WSL ## Installation +> [!Note] +> +> Requires [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0) +> or higher + Use your favorite plugin manager - [vim-plug](https://github.com/junegunn/vim-plug): `Plug 'jiriks74/presence.nvim'` @@ -40,13 +45,13 @@ Use your favorite plugin manager }, ``` -### Notes +Rich Presence should work automatically after installation -- Requires [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0) -or higher -- Rich Presence should work automatically after installation -(unless you're using WSL, in which case -[see here](https://github.com/andweeb/presence.nvim/wiki/Rich-Presence-in-WSL)) +> [!Important] +> +> If you're using WSL1 there's additional setup needed. +> WSL2 **is not supported** but ***may*** work. +> [**See Wiki**](https://github.com/jiriks74/presence.nvim/wiki/Rich-Presence-in-WSL)) ## Configuration