From e27c8342e84b195027202b8c92a5e694f0ea6d46 Mon Sep 17 00:00:00 2001 From: Peter Date: Tue, 17 Dec 2024 08:24:01 -0500 Subject: [PATCH] docs(readme): make channel names consistent everywhere (#138) I made this PR following some confusion I had as a first time user reading the documentation. I tried GitRepos, git-repos and finally had to call list-channels to find the actual name for gitrepos. I think making all of the references to channels consistent with the spelling/capitalization of the CLI helps reduce confusion. --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 96fd6ba..0f7d59a 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ It is inspired by the neovim [telescope](https://github.com/nvim-telescope/teles ## Usage ```bash -tv [channel] #[default: files] [possible values: env, files, git-repos, text, alias] +tv [channel] #[default: files] [possible values: env, files, gitrepos, text, alias] # e.g. to search through files tv files @@ -110,12 +110,12 @@ By default, `television` will launch with the `files` channel on. ## 📺 Built-in Channels The following built-in channels are currently available: -- `Files`: search through files in a directory tree. -- `Text`: search through textual content in a directory tree. -- `GitRepos`: search through git repositories anywhere on the file system. -- `Env`: search through environment variables and their values. -- `Alias`: search through shell aliases and their values. -- `Stdin`: search through lines of text from stdin. +- `files`: search through files in a directory tree. +- `text`: search through textual content in a directory tree. +- `gitrepos`: search through git repositories anywhere on the file system. +- `env`: search through environment variables and their values. +- `alias`: search through shell aliases and their values. +- `stdin`: search through lines of text from stdin. ## 🍿 Cable channels *Tired of broadcast television? Want to watch your favorite shows on demand? `television` has you covered with cable channels. Cable channels are channels that are not built-in to `television` but are instead provided by the community.*