Skip to content

Commit

Permalink
add snippet to readme
Browse files Browse the repository at this point in the history
Signed-off-by: Bryce Palmer <everettraven@gmail.com>
  • Loading branch information
everettraven committed Nov 15, 2023
1 parent 26b6d0e commit 1f664ad
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ kind create cluster

The `test.json` file contains samples for each of the different panel types that `buoy` currently supports. As this is a hobby project very early in the development cycle there are some limitations and things are bound to not work as expected.

`buoy` uses https://github.com/tidwall/gjson for the path evaluation and extracting of values from resources. Please consult their documentation for valid path syntax

## Controls
- `ctrl+c`, `q`, `esc` will quit the program and exit the tui
- `tab` will switch the active tab to the one to the right of the currently active tab
Expand Down

0 comments on commit 1f664ad

Please sign in to comment.