jiriks74/presence.nvim
1
0
Fork 0
mirror of https://github.com/jiriks74/presence.nvim synced 2024-12-28 11:02:34 +01:00
Code Issues Releases Activity Actions

fix(docs): Update README to use my wiki, use Markdown Allerts (#54)
All checks were successful
Luacheck / Luacheck (push) Successful in 9m38s
Details
StyLua / StyLua (push) Successful in 20m25s
Details

Browse source
This commit is contained in:
Jiří Štefka 2024-04-19 23:52:15 +02:00 committed by GitHub
parent e74f180e1b
commit 6fcb4e578e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -18,7 +18,7 @@ This repository uses
- Cross-platform support: macOS, nixOS, Linux[\*](#notes), - Cross-platform support: macOS, nixOS, Linux[\*](#notes),
Windows, WSL Windows, WSL
- Startup time is fast(er than other Rich Presence plugins, by - 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 - Written in Lua and [highly configurable](#configuration) in Lua
(but also configurable in VimL if you want) (but also configurable in VimL if you want)
- Manages Rich Presence across multiple Neovim instances in various environments - Manages Rich Presence across multiple Neovim instances in various environments
@ -27,6 +27,11 @@ Windows, WSL
## Installation ## Installation
> [!Note]
>
> Requires [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0)
> or higher
Use your favorite plugin manager Use your favorite plugin manager
- [vim-plug](https://github.com/junegunn/vim-plug): `Plug 'jiriks74/presence.nvim'` - [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) > [!Important]
or higher >
- Rich Presence should work automatically after installation > If you're using WSL1 there's additional setup needed.
(unless you're using WSL, in which case > WSL2 **is not supported** but ***may*** work.
[see here](https://github.com/andweeb/presence.nvim/wiki/Rich-Presence-in-WSL)) > [**See Wiki**](https://github.com/jiriks74/presence.nvim/wiki/Rich-Presence-in-WSL))
## Configuration ## Configuration