From 0e85561a729b3e3e530113036f7e23f757f535c6 Mon Sep 17 00:00:00 2001 From: Sameer Rahmani Date: Wed, 23 Nov 2022 22:42:28 +0000 Subject: [PATCH] Add the usage info to the readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) 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) +```