Skip to content

Commit

Permalink
docs(readme): make channel names consistent everywhere (#138)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
peter-fh authored Dec 17, 2024
1 parent 882737d commit e27c834
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.*
Expand Down

0 comments on commit e27c834

Please sign in to comment.