github/television
1
1
Fork 0
mirror of https://github.com/alexpasmantier/television.git synced 2025-06-06 19:45:23 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

docs(readme): make channel names consistent everywhere (#138)

Browse Source 
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.
This commit is contained in:
Peter 2024-12-17 08:24:01 -05:00 committed by GitHub
parent 882737d147
commit e27c8342e8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -88,7 +88,7 @@ It is inspired by the neovim [telescope](https://github.com/nvim-telescope/teles
## Usage ## Usage
```bash ```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 # e.g. to search through files
tv files tv files
@ -110,12 +110,12 @@ By default, `television` will launch with the `files` channel on.
## 📺 Built-in Channels ## 📺 Built-in Channels
The following built-in channels are currently available: The following built-in channels are currently available:
- `Files`: search through files in a directory tree. - `files`: search through files in a directory tree.
- `Text`: search through textual content in a directory tree. - `text`: search through textual content in a directory tree.
- `GitRepos`: search through git repositories anywhere on the file system. - `gitrepos`: search through git repositories anywhere on the file system.
- `Env`: search through environment variables and their values. - `env`: search through environment variables and their values.
- `Alias`: search through shell aliases and their values. - `alias`: search through shell aliases and their values.
- `Stdin`: search through lines of text from stdin. - `stdin`: search through lines of text from stdin.
## 🍿 Cable channels ## 🍿 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.* *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.*