Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
reegnz committed Jan 31, 2020
1 parent 4e2b5a6 commit 91c14a5
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,41 @@ This zsh plugin gives you jq superpowers!

## Table of contents

- [Installation](#installation)
- [Usage](#usage)
- [Key bindings](#key-bindings)
- [Demos](#demos)
- [Interactive jq query construction](#interactive-jq-query-construction)
- [Insert jq query in the middle of a pipeline](#insert-jq-query-in-the-middle-of-a-pipeline)

## Installation

This plugin requires [fzf](https://github.com/junegunn/fzf) to be available
on your PATH.

The project consists of two components:
- a `jq-repl` command
- a `jq.plugin.zsh` providing line-editor feature using `jq-repl`


### [zplug](https://github.com/zplug/zplug)

```sh
zplug reegnz/jq-zsh-plugin
```

### [Antigen](https://github.com/zsh-users/antigen)

```sh
antigen bundle reegnz/jq-zsh-plugin
```

### [Zgen](https://github.com/tarjoilija/zgen)

```sh
zgen load reegnz/jq-zsh-plugin
```

## Usage

- type out a command that you expect to produce json on it's standard output
Expand Down

0 comments on commit 91c14a5

Please sign in to comment.