From 9849751f61ec5bfce44a7a18db90179658a03165 Mon Sep 17 00:00:00 2001 From: vyfor Date: Wed, 22 Jan 2025 16:02:04 +0500 Subject: [PATCH] docs(readme): update feature section --- .github/wiki/Troubleshooting.md | 5 ++++- README.md | 8 ++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/.github/wiki/Troubleshooting.md b/.github/wiki/Troubleshooting.md index 23d2089a..13b7e2aa 100644 --- a/.github/wiki/Troubleshooting.md +++ b/.github/wiki/Troubleshooting.md @@ -10,7 +10,7 @@ Lazy may be unable to update to the new branch from the `master` branch, in whic - **Windows:** ```pwsh - rm \"$env:LOCALAPPDATA/nvim-data/lazy/cord.nvim\" -r -force + rm "$env:LOCALAPPDATA/nvim-data/lazy/cord.nvim" -r -force ``` ### Rich Presence is not shown in Discord @@ -37,6 +37,9 @@ Lazy may be unable to update to the new branch from the `master` branch, in whic ### Rich Presence timer is stuck at 00:00 - This issue is usually resolved by syncing your system date and timezone +### Using Discord in browser +- Discord doesn't expose the IPC pipe when running in the browser. Luckily, you can use [arrpc](https://github.com/OpenAsar/arrpc) to create a bridge and send presence updates + ### Running inside WSL - WSL doesn't expose Windows pipes by default. In order to do so, install [socat](https://www.kali.org/tools/socat) and [npiperelay](https://github.com/jstarks/npiperelay/), then alias nvim to expose the pipe as done in this [guide](https://gist.github.com/mousebyte/af45cbecaf0028ea78d0c882c477644a#aliasing-nvim): > ```sh diff --git a/README.md b/README.md index 7eda9264..588d23ca 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,15 @@ - 🧠 **Automated State Handling** — Automatically manages activities across all instances. - 💤 **Smart Idle Detection** — Identifies idle sessions and switches to the most recent non-idle session. - 🛠️ **Built-in Git Integration** — Detects repositories and workspaces based on VCS files without relying on command-line tools. -- 🔌 **Plugin System** — Extendable with custom plugins, with plenty of built-in ones out of the box. -- 🌍 **Cross-Platform** — Supports Windows, Linux (Flatpak/Snap), macOS, and BSD. +- 🗃️ **Custom Assets** — Extendable with fully customizable assets for any file/buffer type. +- ⚙️ **Robust User Commands** - Quickly manage Cord and its features through user commands and easily create your own keybindings. +- 🔌 **Plugin System** — Extendable with custom plugins, with a plethora of built-in ones out of the box. +- 📦 **Wide Compatibility** - Compatible with various Discord installations (Snap, Flatpak) and able to work inside [WSL](https://github.com/vyfor/cord.nvim/wiki/Troubleshooting#running-inside-wsl) and [Discord in browser](https://github.com/vyfor/cord.nvim/wiki/Troubleshooting#using-discord-in-browser). +- 🌍 **Cross-Platform** — Supports Windows, Linux, macOS, and FreeBSD. - 🌸 **Rich Icon Collection** — Features 120+ uniquely designed themed icons for 200+ file types and plugins. - 🔁 **Automatic Reconnection** — Able to reconnect to Discord if the connection is lost. + ## 📦 Install ### Considerations