diff --git a/README.md b/README.md index 576f5cc..ce9afe8 100644 --- a/README.md +++ b/README.md @@ -23,28 +23,31 @@ as the \*BSDs. ## Table of Contents -- [Resource Footprint Comparison](#resource-footprint-comparison) -- [Installation](#installation) - - [On macOs](#on-macos) - - [On Windows](#on-windows) - - [On Linux](#on-linux) -- [Build](#build) - - [Audio Backends](#audio-backends) -- [Key Bindings](#build) - - [Navigation](#navigation) - - [Playback](#playback) - - [Context Menus](#context-menus) - - [Sharing](#sharing) - - [Queue](#queue) - - [Library](#library) - - [Vim-like Search Bat](#vim-like-search-bar) -- [Vim-Like Commands](#vim-like-commands) -- [Configuration](#configuration) - - [Custom Keybindings](#custom-keybindings) - - [Proxy](#proxy) - - [Theming](#theming) -- [Cover Drawing](#cover-drawing) -- [Authentication](#authentication) +- [ncspot](#ncspot) + - [Table of Contents](#table-of-contents) + - [Resource Footprint Comparison](#resource-footprint-comparison) + - [Installation](#installation) + - [On macOS](#on-macos) + - [On Windows](#on-windows) + - [On Linux](#on-linux) + - [Building a Debian Package](#building-a-debian-package) + - [Build](#build) + - [Audio Backends](#audio-backends) + - [Key Bindings](#key-bindings) + - [Navigation](#navigation) + - [Playback](#playback) + - [Context Menus](#context-menus) + - [Sharing](#sharing) + - [Queue](#queue) + - [Library](#library) + - [Vim-Like Search Bar](#vim-like-search-bar) + - [Vim-Like Commands](#vim-like-commands) + - [Configuration](#configuration) + - [Custom Keybindings](#custom-keybindings) + - [Proxy](#proxy) + - [Theming](#theming) + - [Cover Drawing](#cover-drawing) + - [Authentication](#authentication) ## Resource Footprint Comparison @@ -228,8 +231,8 @@ When pressing O: | Key | Command | | :---------------------------- | :------------------------------------------------------------------------------ | -| X | Copy a sharable URL of the **currently selected item** to the system clipboard. | -| Shift+X | Copy a sharable URL of the **currently playing track** to the system clipboard. | +| X | Copy a shareable URL of the **currently selected item** to the system clipboard. | +| Shift+X | Copy a shareable URL of the **currently playing track** to the system clipboard. | ### Queue @@ -249,53 +252,52 @@ When pressing O: | Key | Command | | :----------- | :------------------------- | -| n | Previous search occurence. | -| N | Next search occurence. | +| n | Previous search occurrence. | +| N | Next search occurrence. | ## Vim-Like Commands You can open a Vim-style command prompt using :, and close it at any time with Escape. -The following commands are supported: +The following is an abridged list of commonly-used commands. For the full list, see [source code](/src/command.rs). | Command | Action | |---|---| -| `quit` | Quit `ncspot`. | +| `help` | Show current key bindings. | +| `quit`
Aliases: `q`, `x` | Quit `ncspot`. | | `logout` | Remove any cached credentials from disk and quit `ncspot`. | -| `toggle` | Toggle playback. | +| `playpause`
Aliases: `pause`, `toggleplay`, `toggleplayback` | Toggle playback. | | `stop` | Stop playback. | | `seek [+\|-]