Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aleksandersh committed Aug 31, 2024
1 parent 0df4f0a commit ebfa6f1
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,13 @@ The tool is a client with a user interface for the [Task](https://taskfile.dev/)

## Features

- list and launch tasks
- filter tasks
- List and execute tasks
- Filtering mode to speed up navigation between tasks
- Task summary page to show the description of a task

🟥 __The [labels](https://taskfile.dev/usage/#overriding-task-name) are not properly supported right now__ 🟥

If you are using [labels](https://taskfile.dev/usage/#overriding-task-name), you must also specify [namespace alias](https://taskfile.dev/usage/#namespace-aliases) or [task alias](https://taskfile.dev/usage/#task-aliases) for these tasks.
If you are using [labels](https://taskfile.dev/usage/#overriding-task-name), you must also specify [namespace alias](https://taskfile.dev/usage/#namespace-aliases) or [task alias](https://taskfile.dev/usage/#task-aliases) for those tasks.

## Usage

Expand All @@ -31,11 +32,16 @@ task-tui --help

#### Hotkeys

`/` - to enter filtering mode
`Enter` - to execute the selected task
`/` - to enter the filtering mode
`s` - to show the task summary
`Esc` - to go back
`Ctrl+C` - to exit
`h` - to show the help page

## Installation

Make sure that Task is [installed](https://taskfile.dev/installation/).
Make sure Task is [installed](https://taskfile.dev/installation/).

#### Homebrew tap

Expand Down

0 comments on commit ebfa6f1

Please sign in to comment.