Skip to content

Commit

Permalink
docs: typos suggestion (noahgorstein#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
ccoVeille authored May 8, 2024
1 parent 16ccec4 commit 0ef7d0b
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# jqp
# jqp

a TUI playground for exploring jq.

Expand Down Expand Up @@ -26,13 +26,13 @@ Available through the Arch User Repository as [jqp-bin](https://aur.archlinux.or
yay -S jqp-bin
```

### Github releases
### GitHub releases

Download the relevant asset for your operating system from the latest Github release. Unpack it, then move the binary to somewhere accessible in your `PATH`, e.g. `mv ./jqp /usr/local/bin`.
Download the relevant asset for your operating system from the latest GitHub release. Unpack it, then move the binary to somewhere accessible in your `PATH`, e.g. `mv ./jqp /usr/local/bin`.

### Build from source

Clone this repo, build from source with `cd jqp && go build`, then move the binary to somewhere accessible in your `PATH`, e.g. `mv ./jqp /usr/local/bin`.
Clone this repository, build from source with `cd jqp && go build`, then move the binary to somewhere accessible in your `PATH`, e.g. `mv ./jqp /usr/local/bin`.

## Usage

Expand All @@ -51,24 +51,24 @@ Flags:
-v, --version version for jqp
```

`jqp` also supports input from STDIN. STDIN takes precedence over the command line flag.
`jqp` also supports input from STDIN. STDIN takes precedence over the command-line flag.

```
➜ curl "https://api.github.com/repos/stedolan/jq/issues?per_page=2" | jqp
➜ curl "https://api.github.com/repos/stedolan/jq/issues?per_page=2" | jqp
```

> [!NOTE]
> Valid JSON or NDJSON [(newline-delimted JSON)](https://jsonlines.org/) can be provided as input to `jqp`.
> Valid JSON or NDJSON [(newline-delimited JSON)](https://jsonlines.org/) can be provided as input to `jqp`.
## Keybindings
## Keybindings

| **Keybinding** | **Action** |
|:---------------|:-----------|
| `tab` | cycle through sections |
| `shift-tab` | cycle through sections in reverse |
| `ctrl-y` | copy query to system clipboard[^1] |
| `ctrl-s` | save output to file (copy to clipboard if file not specified) |
| `ctrl-c` | quit program / kill long running query |
| `ctrl-c` | quit program / kill long-running query |

### Query Mode

Expand Down Expand Up @@ -96,13 +96,13 @@ Flags:

## Configuration

`jqp` can be configured with a configuration file. By default, `jqp` will search your home directory for a YAML file named `.jqp.yaml`. A path to a YAML configuration file can also be provided to the `--config` command line flag.
`jqp` can be configured with a configuration file. By default, `jqp` will search your home directory for a YAML file named `.jqp.yaml`. A path to a YAML configuration file can also be provided to the `--config` command-line flag.

```bash
➜ jqp --config ~/my_jqp_config.yaml < data.json
```

If a configuration option is present in both the configuration file and the command line, the command line option takes precedence. For example, if a theme is specified in the configuration file and via `-t/--theme flag`, the command line flag will take precedence.
If a configuration option is present in both the configuration file and the command-line, the command-line option takes precedence. For example, if a theme is specified in the configuration file and via `-t/--theme flag`, the command-line flag will take precedence.

### Available Configuration Options

Expand All @@ -115,7 +115,7 @@ theme:
## Themes
Themes can be specified on the command line via the `-t/--theme <themeName>` flag. You can also set a theme in your [configuration file](#configuration).
Themes can be specified on the command-line via the `-t/--theme <themeName>` flag. You can also set a theme in your [configuration file](#configuration).

```yaml
theme:
Expand All @@ -126,7 +126,7 @@ theme:

### Chroma Style Overrides

Overrides to the chroma styles used for a theme can be configured in your [configuration file](#configuration).
Overrides to the chroma styles used for a theme can be configured in your [configuration file](#configuration).

For the list of short keys, see [`chroma.StandardTypes`](https://github.com/alecthomas/chroma/blob/d38b87110b078027006bc34aa27a065fa22295a1/types.go#L210-L308). To see which token to use for a value, see the [JSON lexer](https://github.com/alecthomas/chroma/blob/master/lexers/embedded/json.xml) (look for `<token>` tags). To see the color and what's used in the style you're using, look for your style in the chroma [styles directory](https://github.com/alecthomas/chroma/tree/master/styles).

Expand All @@ -148,7 +148,7 @@ theme:
success: "#87a987"
```

Themes are broken up into [light](#light-themes) and [dark](#dark-themes) themes. Light themes work best in terminals with a light background and dark themes work best in a terminal with a dark background. If no theme is specified or a non-existant theme is provided, the default theme is used, which was created to work with both terminals with a light and dark background.
Themes are broken up into [light](#light-themes) and [dark](#dark-themes) themes. Light themes work best in terminals with a light background and dark themes work best in a terminal with a dark background. If no theme is specified or a non-existent theme is provided, the default theme is used, which was created to work with both terminals with a light and dark background.

### Light Themes

Expand Down Expand Up @@ -188,8 +188,8 @@ Themes are broken up into [light](#light-themes) and [dark](#dark-themes) themes
- `catppuccin-frappe`
- `catppuccin-macchiato`
- `catppuccin-mocha`
- `doom-one`
- `doom-one2`
- `doom-one`
- `doom-one2`
- `dracula`
- `fruity`
- `github-dark`
Expand Down

0 comments on commit 0ef7d0b

Please sign in to comment.