Merge pull request #12 from essentialkaos/develop

Version 1.0.0

.github/workflows/ci.yml

@@ -39,8 +39,12 @@ jobs:
 
       - name: Download dependencies
         working-directory: ${{env.SRC_DIR}}
-        run: make deps
+        run: make deps deps-test
 
       - name: Build binary
         working-directory: ${{env.SRC_DIR}}
         run: make all
+
+      - name: Test go-fuzz output parser
+        working-directory: ${{env.SRC_DIR}}
+        run: make test

Makefile

@@ -8,7 +8,7 @@
 ################################################################################
 
 .DEFAULT_GOAL := help
-.PHONY = fmt vet all clean git-config deps help
+.PHONY = fmt vet all clean git-config deps deps-test test help
 
 ################################################################################
 
@@ -29,6 +29,12 @@ git-config: ## Configure git redirects for stable import path services
 deps: git-config ## Download dependencies
 	go get -d -v pkg.re/essentialkaos/ek.v12
 
+deps-test: git-config ## Download dependencies for tests
+	go get -d -v pkg.re/essentialkaos/check.v1
+
+test: ## Run tests
+	go test -covermode=count ./gofuzz
+
 fmt: ## Format source code with gofmt
 	find . -name "*.go" -exec gofmt -s -w {} \;
 

README.md

@@ -8,7 +8,7 @@
   <a href="#license"><img src="https://gh.kaos.st/apache2.svg"></a>
 </p>
 
-<p align="center"><a href="#installation">Installation</a> • <a href="#usage">Usage</a> • <a href="#build-status">Build Status</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>
+<p align="center"><a href="#usage-demo">Demo</a> • <a href="#installation">Installation</a> • <a href="#command-line-completion">Completions</a> • <a href="#man-documentation">Man documentation</a> • <a href="#usage">Usage</a> • <a href="#build-status">Build Status</a> • <a href="#license">License</a></p>
 
 <br/>
 
@@ -30,12 +30,41 @@ go install github.com/essentialkaos/fz
 
 #### Prebuilt binaries
 
-You can download prebuilt binaries for Linux and OS X from [EK Apps Repository](https://apps.kaos.st/fz/latest):
+You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/fz/latest):
 
 ```bash
 bash <(curl -fsSL https://apps.kaos.st/get) fz
 ```
 
+### Command-line completion
+
+You can generate completion for `bash`, `zsh` or `fish` shell.
+
+Bash:
+```bash
+sudo fz --completion=bash 1> /etc/bash_completion.d/fz
+```
+
+
+ZSH:
+```bash
+sudo fz --completion=zsh 1> /usr/share/zsh/site-functions/fz
+```
+
+
+Fish:
+```bash
+sudo fz --completion=fish 1> /usr/share/fish/vendor_completions.d/fz.fish
+```
+
+### Man documentation
+
+You can generate man page for `fz` using next command:
+
+```bash
+fz --generate-man | sudo gzip > /usr/share/man/man1/fz.1.gz
+```
+
 ### Usage
 
 ```