From ce451c1024e0301d2e60b38c93805abd14316e74 Mon Sep 17 00:00:00 2001 From: fuwaa Date: Wed, 24 Aug 2022 17:09:10 +0800 Subject: [PATCH] fix readme --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0957260..f812c83 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # inkdrop command palette + A VSCode-like command palette for Inkdrop. ![Inkdrop_logbdEi1qT](https://user-images.githubusercontent.com/53419401/186372300-eadccb9e-5acb-4771-ac1c-1d46728ce75a.gif) ## Features + - Access and Invoke almost any command in Inkdrop. - Filter commands by `.` for Formatting Commands and by `>` for application commands. - Know which keyboard shortcuts are associated per command[^1]. @@ -11,30 +13,36 @@ A VSCode-like command palette for Inkdrop. - Extensible and easily configurable for plugin developers. ## Install + ```css ipm install command-palette ``` ## Keybindings -| Command | Explanation | Keybind | -|--|--|--| -|commandpalette:toggle| Shows/Hides the Command Palette | Ctrl+K + +| Command | Explanation | Keybind | +| --------------------- | ------------------------------- | ------- | +| commandpalette:toggle | Shows/Hides the Command Palette | Ctrl+K | #### add it to your keymap.cson + ```js -'body': +'body': 'ctrl-k': 'commandpalette:toggle' ``` +## Changelog -### Changelog #### 1.0.0 - 08/24/2022 + - Initial release, yay! -### Ideas +## Ideas + - [ ] configurable settings? I don't know what to put here though... -### Todo +## Todo + - [ ] ability to use commands that require an argument, **requires a bit of reverse engineering** - [ ] finalize decision on whether i should isolate commands such as `focus on ****` because we'd be already focusing on it or have another command invokable related to it that works targeted by the selector[^3]. - [ ] code documentation/prettify to make it less stressful on the eyes. @@ -43,4 +51,3 @@ ipm install command-palette [^1]: Current version is limited to only default keybindings, planned support for user defined `keymaps.cson` is in the works. [^2]: Provided that the plugin developer provides support for their command via `lib/commands/plugins.js` [^3]: For now, if you search for a command like that, it won't show anything but it's always visible on the full list, oh and you can't invoke it either. -