Skip to content

Commit

Permalink
fix(docs): Update README to use my wiki, use Markdown Allerts (#54)
Browse files Browse the repository at this point in the history
  • Loading branch information
jiriks74 authored Apr 19, 2024
1 parent e74f180 commit 6fcb4e5
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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'`
Expand All @@ -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

Expand Down

0 comments on commit 6fcb4e5

Please sign in to comment.