Skip to content

Commit

Permalink
Expand README to include installing and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
academo committed Jul 13, 2021
1 parent 9938193 commit 577ac75
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
# Setting up development
# About
kibbe is a cli tool to ease common tasks when developing plugins for kibana.

# Installing

- Download the [latest release](https://github.com/academo/kibbe/releases) from this repository.
- Give it running permissions `chmod +x kibbe`
- Add it to your path (e.g. `cp kibbe .local/bin`)

# Usage

Run `kibbe --help` to see a list of commands.

you can run `--help` on any subcommand to get more information about arguments, options and what subcommands do.

e.g.:

`kibbe check --help`

# Collaborating - Setting up development

Note: Everything in this readme and project assumes python 3

Expand Down

0 comments on commit 577ac75

Please sign in to comment.