aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiuseppe Gadola <giusgadola@gmail.com>2023-02-25 10:08:10 +0100
committerGiuseppe Gadola <giusgadola@gmail.com>2023-02-25 11:07:18 +0100
commite5d5b58ec66c82b2478aa7e244a7cbc2cd89217c (patch)
tree94c1fb712d7945642dbc156e6f932ee34ee15ab0
parentdocs(help): auto generate docs (diff)
chore: licensing issue
-rw-r--r--README.md1
1 files changed, 1 insertions, 0 deletions
diff --git a/README.md b/README.md
index 55f9112..570f297 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
# pets.nvim
> ⚠️⚠️⚠️ Currently the plugin is not working and is searching for new assets. See #26
+
Pets.nvim is a plugin that provides the missing core functionality of showing little animal friends inside your editor.
It relies on the [kitty graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol/) and [hologram.nvim](https://github.com/edluffy/hologram.nvim) to be able to display images in a terminal window.
As you might know the plugin is heavily inspired by [vscode-pets](https://github.com/tonybaloney/vscode-pets/tree/master/media).