Skip to content

Commit 1af5b1a

Browse files
committed
update docs to reflect font issue
1 parent fd66e97 commit 1af5b1a

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ The plugin is written in Lua and depends heavily on the Plenary library for its
2626
- [nvim-lua/plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
2727
- [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons)
2828

29+
*NOTICE* Please check the nvim-web-devicons repo for information on breaking changes to Nerd Fonts. This dependency is used to show the icons in this plugin and requires a compatible font. Thank you to Github user @david-0609 for bringing this to my attention and updating the icons used in this application. Should you encounter missing icons please upgrade the font you are using so it is using 2.3 or 3.0.
30+
31+
_If you do not wish to upgrade your font you can pin to a previous version of the plugin using tag v0.8.0 instead of the main branch._
32+
2933
### OS dependencies
3034
On Windows and macOS, PowerShell and pmset are used to obtain battery status respectively.
3135
For Linux `acpi` is used, and may not be installed by default on your distribution. See [How to handle acpi events on Linux](https://linuxconfig.org/how-to-handle-acpi-events-on-linux). The package must be correctly installed and in your executable path.

0 commit comments

Comments
 (0)