diff --git a/README.md b/README.md index 73df470..a51b78b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ # filter -A simple tool to filter the input interactively in a POSIX pipeline. \ No newline at end of file +A simple tool to filter the input interactively in a POSIX pipeline. + +## How to build? +Just run `go build .` + +## Usage +Use the filter command in a pipeline like: + +```bash +git commit -a --fixup $(g log --oneline|./filter|cut -d ' ' -f 1 |xargs) +```