add keybindings to UI window (#140)

- Allows for expanding servers to view more information about it.
- Allows for installing/reinstalling/uninstalling servers.

The default keybindings is an attempt to mimic vim-fugitive's :Git
maps, and these can be overriden.

The keybinding implementation in display.lua is a bit hacky, but it
works and the "public" API is at least manageable. This will also
open up for adding more metadata in the future, such as filetype
information, currently installed version, latest available version,
etc.

Also there's Cowth Vader.

1 files changed, 41 insertions, 27 deletions

diff --git a/README.md b/README.md
index aee37ee3..41b038a8 100644
--- a/README.md
+++ b/README.md
@@ -116,33 +116,6 @@ require("nvim-lsp-installer").settings {
 }
 ```
 
-#### Default configuration
-
-```lua
-local DEFAULT_SETTINGS = {
-    ui = {
-        icons = {
-            -- The list icon to use for installed servers.
-            server_installed = "◍",
-            -- The list icon to use for servers that are pending installation.
-            server_pending = "◍",
-            -- The list icon to use for servers that are not installed.
-            server_uninstalled = "◍",
-        },
-    },
-
-    -- Controls to which degree logs are written to the log file. It's useful to set this to vim.log.levels.DEBUG when
-    -- debugging issues with server installations.
-    log_level = vim.log.levels.INFO,
-
-    -- Whether to allow LSP servers to share the same installation directory. For some servers, this effectively causes
-    -- more than one server to be installed (and uninstalled) when executing `:LspInstall` and `:LspUninstall`. For
-    -- example, installing `cssls` will also install both `jsonls` and `html` (and the other ways around), as these all
-    -- share the same underlying package.
-    allow_federated_servers = true,
-}
-```
-
 ## Available LSPs
 
 | Language                            | Server name              |
@@ -226,3 +199,44 @@ Illustrations in the logo are derived from [@Kaligule](https://schauderbasis.de/
 -   Command (and corresponding Lua API) to update outdated servers (e.g., `:LspUpdate {server}`)
 -   More helpful metadata displayed in the UI window
 -   Cross-platform CI for all server installers
+
+## Default configuration
+
+```lua
+local DEFAULT_SETTINGS = {
+    ui = {
+        icons = {
+            -- The list icon to use for installed servers.
+            server_installed = "◍",
+            -- The list icon to use for servers that are pending installation.
+            server_pending = "◍",
+            -- The list icon to use for servers that are not installed.
+            server_uninstalled = "◍",
+        },
+        keymaps = {
+            -- Keymap to expand a server in the UI
+            toggle_server_expand = "<CR>",
+            -- Keymap to install a server
+            install_server = "i",
+            -- Keymap to reinstall/update a server
+            update_server = "u",
+            -- Keymap to uninstall a server
+            uninstall_server = "X",
+        },
+    },
+
+    -- Controls to which degree logs are written to the log file. It's useful to set this to vim.log.levels.DEBUG when
+    -- debugging issues with server installations.
+    log_level = vim.log.levels.INFO,
+
+    -- Whether to allow LSP servers to share the same installation directory. For some servers, this effectively causes
+    -- more than one server to be installed (and uninstalled) when executing `:LspInstall` and `:LspUninstall`. For
+    -- example, installing `cssls` will also install both `jsonls` and `html` (and the other ways around), as these all
+    -- share the same underlying package.
+    allow_federated_servers = true,
+
+    -- Limit for the maximum amount of servers to be installed at the same time. Once this limit is reached, any further
+    -- servers that are requested to be installed will be put in a queue.
+    max_concurrent_installers = 4,
+}
+```