diff --git a/README.md b/README.md index d12ecf2..968efec 100644 --- a/README.md +++ b/README.md @@ -50,80 +50,7 @@ It is inspired by the neovim [telescope](https://github.com/nvim-telescope/teles ## Installation -
-Homebrew - - ```bash - brew install television - ``` - -
-
- - Arch Linux - - - ```bash - pacman -S television - ``` - -
-
- - Debian-based (Debian, Ubuntu, Pop!_OS, Linux Mint, etc.) - - - ```bash - curl -LO https://github.com/alexpasmantier/television/releases/download/0.8.0/television_0.8.0-1_amd64.deb - sudo dpkg -i television_0.8.0-1_amd64.deb - ``` - -
-
- - Conda-forge (cross-platform) - - - ```bash - pixi global install television - ``` -
-
- - Binary - - - From the [latest release](https://github.com/alexpasmantier/television/releases/latest) page: - - Download the latest release asset for your platform (e.g. `tv-vX.X.X-linux-x86_64.tar.gz` if you're on a linux x86 machine) - - Unpack and copy to the relevant location on your system (e.g. `/usr/local/bin` on macos and linux for a global installation) - -
-
- - Cargo - - - Setup the latest stable Rust toolchain via rustup: - ```bash - curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - rustup update - ``` - Install `television`: - ```bash - cargo install --locked television - ``` -
- -### Shell integration - -To enable shell integration, run: -```bash -echo 'eval "$(tv init zsh)"' >> ~/.zshrc -``` -And then restart your shell. Hitting Ctrl-T in your shell will now provide you with smart completion powered -by `television`. - -*Support for other shells is coming soon.* +See the [installation docs](https://github.com/alexpasmantier/television/wiki/Installation). ## Usage @@ -140,26 +67,26 @@ my_program | tv fd -t f . | tv --preview 'bat -n --color=always {0}' ``` -By default, `television` will launch with the `files` channel on. - -![the files channel](./assets/tv-files-broadcom.png) - *`tv`'s `files` channel running on the *linux* codebase* - *For more information on the different channels, see the [channels](./docs/channels.md) documentation.* +Television can also integrate with your shell to provide autocompletion based on the commands you start typing. See [Shell Autocompletion](https://github.com/alexpasmantier/television/wiki/Shell-Autocomletion). + +https://github.com/user-attachments/assets/4151ea30-3b42-42e3-9fbd-0a5c5e9ba1c7 + ## Keybindings Default keybindings are as follows: | Key | Description | | :---: | ----------- | -| / | Navigate through the list of entries | +| / or Ctrl + p / n or Ctrl + k / j | Navigate through the list of entries | | Ctrl + u / d | Scroll the preview pane up / down | | Enter | Select the current entry | | Ctrl + y | Copy the selected entry to the clipboard | | Ctrl + r | Toggle remote control mode | | Ctrl + s | Toggle send to channel mode | | Ctrl + g | Toggle the help panel | +| Ctrl + o | Toggle the preview panel | | Esc | Quit the application | These keybindings are all configurable (see [Configuration](#configuration)).