Skip to content

Commit

Permalink
docs(readme): update feature section
Browse files Browse the repository at this point in the history
  • Loading branch information
vyfor committed Jan 22, 2025
1 parent 2a7f43a commit 9849751
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
5 changes: 4 additions & 1 deletion .github/wiki/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9849751

Please sign in to comment.