From fee2f8d2bd603fc0fa102deb45d03191d3738ced Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20=C5=A0tefka?= Date: Wed, 28 Feb 2024 18:37:44 +0100 Subject: [PATCH] fix(docs): Remove issues reported by Markdownlint (#37) * 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. --- README.md | 33 +++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 29e3119..912282b 100644 --- a/README.md +++ b/README.md @@ -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) -presence.nvim​ - -**[Features](#features)** | **[Installation](#installation)** | **[Configuration](#configuration)** | **[Troubleshooting](#troubleshooting)** | **[Development](#development)** | **[Contributing](#contributing)** +**[Features](#features)** | **[Installation](#installation)** | +**[Configuration](#configuration)** | **[Troubleshooting](#troubleshooting)** | +**[Development](#development)** | **[Contributing](#contributing)** > Discord [Rich Presence](https://discord.com/rich-presence) plugin for [Neovim](https://neovim.io) -demo.gif +![Presence demo](https://gist.githubusercontent.com/andweeb/df3216345530234289b87cf5080c2c60/raw/ad916fec8de921d0021801a0af877a5349621e7e/presence-demo-a.gif) ## Features @@ -14,7 +17,8 @@ - No Python/Node providers (or CoC) required - 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)) +- 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 (but also configurable in VimL if you want) - Manages Rich Presence across multiple Neovim instances in various environments @@ -36,13 +40,13 @@ Use your favorite plugin manager }, ``` - ### Notes - 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)) +(unless you're using WSL, in which case +[see here](https://github.com/andweeb/presence.nvim/wiki/Rich-Presence-in-WSL)) ## 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` - If there is a `Failed to determine Discord IPC socket` error, your particular 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) - 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]`) -- 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 @@ -139,10 +146,12 @@ errors: `luacheck lua` ## 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.** -**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 or message [me (@jiriks74)](https://discordapp.com/users/517810049360461837) on my