jiriks74/presence.nvim
1
0
Fork 0
mirror of https://github.com/jiriks74/presence.nvim synced 2024-11-23 20:37:50 +01:00
Code Issues Actions Releases Activity

fix(docs): Remove issues reported by Markdownlint (#37)

Browse Source 
* fix(docs): Remove inline HTML elements

* fix(docs): Lines longer than 80 characters

* fix(docs): Lines over 80 chars

* fix: docs

* fix(docs): readability

* fix(docs): MD043 - Required heading structure

* Revert "fix(docs): MD043 - Required heading structure"

This reverts commit fa2179bc85d94354026191a31cb11a52bee4cfd7.
This commit is contained in:
Jiří Štefka 2024-02-28 18:37:44 +01:00 committed by GitHub
parent b43882cc60
commit fee2f8d2bd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,12 +1,15 @@
# ![presence.nvim](https://gist.githubusercontent.com/andweeb/df3216345530234289b87cf5080c2c60/raw/8de399cfed82c137f793e9f580027b5246bc4379/presence.nvim.png)
This repository uses
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
<img src="https://gist.githubusercontent.com/andweeb/df3216345530234289b87cf5080c2c60/raw/8de399cfed82c137f793e9f580027b5246bc4379/presence.nvim.png" alt="presence.nvim">&#x200B; **[Features](#features)** | **[Installation](#installation)** |
**[Configuration](#configuration)** | **[Troubleshooting](#troubleshooting)** |
**[Features](#features)** | **[Installation](#installation)** | **[Configuration](#configuration)** | **[Troubleshooting](#troubleshooting)** | **[Development](#development)** | **[Contributing](#contributing)** **[Development](#development)** | **[Contributing](#contributing)**
> Discord [Rich Presence](https://discord.com/rich-presence) plugin for [Neovim](https://neovim.io) > Discord [Rich Presence](https://discord.com/rich-presence) plugin for [Neovim](https://neovim.io)
<img src="https://gist.githubusercontent.com/andweeb/df3216345530234289b87cf5080c2c60/raw/ad916fec8de921d0021801a0af877a5349621e7e/presence-demo-a.gif" width="100%" alt="demo.gif"> ![Presence demo](https://gist.githubusercontent.com/andweeb/df3216345530234289b87cf5080c2c60/raw/ad916fec8de921d0021801a0af877a5349621e7e/presence-demo-a.gif)
## Features ## Features
@ -14,7 +17,8 @@
- No Python/Node providers (or CoC) required - No Python/Node providers (or CoC) required
- 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 [kind of a lot](https://github.com/andweeb/presence.nvim/wiki/Plugin-Comparisons)) - Startup time is fast(er than other Rich Presence plugins, by
[kind of a lot](https://github.com/andweeb/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
@ -36,13 +40,13 @@ Use your favorite plugin manager
}, },
``` ```
### Notes ### Notes
- Requires [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0) - Requires [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0)
or higher or higher
- Rich Presence should work automatically after installation - 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)) (unless you're using WSL, in which case
[see here](https://github.com/andweeb/presence.nvim/wiki/Rich-Presence-in-WSL))
## Configuration ## Configuration
@ -121,11 +125,14 @@ let g:presence_line_number_text = "Line %s out of %s"
- Load a file and inspect the logs with `:messages` - Load a file and inspect the logs with `:messages`
- If there is a `Failed to determine Discord IPC socket` error, your particular - If there is a `Failed to determine Discord IPC socket` error, your particular
OS may not yet be supported OS may not yet be supported
- If you don't see an existing [issue](https://github.com/jiriks74/presence.nvim/issues) - If you don't see an existing
[issue](https://github.com/jiriks74/presence.nvim/issues)
or [card](https://github.com/jiriks74/presence.nvim/projects/1#column-14183588) or [card](https://github.com/jiriks74/presence.nvim/projects/1#column-14183588)
for your OS, create a prefixed [issue](https://github.com/jiriks74/presence.nvim/issues/new) for your OS, create a prefixed
[issue](https://github.com/jiriks74/presence.nvim/issues/new)
(e.g. `[Void Linux]`) (e.g. `[Void Linux]`)
- Still not working and need help? Create a new [issue](https://github.com/jiriks74/presence.nvim/issues)! - Still not working and need help? Create a new
[issue](https://github.com/jiriks74/presence.nvim/issues)!
## Development ## Development
@ -139,10 +146,12 @@ errors: `luacheck lua`
## Contributing ## Contributing
**Please use [Conventional Commits](https://www.conventionalcommits.org/) if you want to contribute. **Please use [Conventional Commits](https://www.conventionalcommits.org/)
if you want to contribute.
It makes everyones jobs easier.** It makes everyones jobs easier.**
**This project uses [StyLua](https://github.com/JohnnyMorganz/StyLua). Please format your code using StyLua for better readability** **This project uses [StyLua](https://github.com/JohnnyMorganz/StyLua).
Please format your code using StyLua for better readability**
Pull requests are very welcome, feel free to open an issue to work on Pull requests are very welcome, feel free to open an issue to work on
or message [me (@jiriks74)](https://discordapp.com/users/517810049360461837) on my or message [me (@jiriks74)](https://discordapp.com/users/517810049360461837) on my