summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGoreadme <EMAIL:[email protected]>2020-04-09 18:35:26 +0000
committerGoreadme <EMAIL:[email protected]>2020-04-09 18:35:26 +0000
commit206739e66fd61fd5bfe4aa7f906878f3f250f341 (patch)
tree9db6844717dfc403bd8fb4c437dcd861cf30255a
parentb22f70f90a324f0bb276efe566f9fa92ad145a62 (diff)
Update readme according to Go doc
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index e4125b2..617d333 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,6 @@
[![Build Status](https://travis-ci.org/posener/complete.svg?branch=master)](https://travis-ci.org/posener/complete)
[![codecov](https://codecov.io/gh/posener/complete/branch/master/graph/badge.svg)](https://codecov.io/gh/posener/complete)
-[![golangci](https://golangci.com/badges/github.com/posener/complete.svg)](https://golangci.com/r/github.com/posener/complete)
-[![GoDoc](https://godoc.org/github.com/posener/complete?status.svg)](https://pkg.go.dev/github.com/posener/complete/v2?tab=doc)
[![goreadme](https://goreadme.herokuapp.com/badge/posener/complete.svg)](https://goreadme.herokuapp.com)
Package complete is everything for bash completion and Go.
@@ -22,7 +20,7 @@ This package provides:
* Enables an easy way to install/uninstall the completion of the command.
The library and tools are extensible such that any program can add its one logic, completion types
-or methologies.
+or methologies. See the [documentation](https://pkg.go.dev/github.com/posener/complete/v2?tab=doc).
#### Go Command Bash Completion
@@ -150,13 +148,17 @@ For command line bash completion testing use the `complete.Test` function.
* [compflag](./compflag): Package compflag provides a handful of standard library-compatible flags with bash complition capabilities.
+* [example/command](./example/command): command shows how to have bash completion to an arbitrary Go program using the `complete.Command` struct.
+
+* [example/compflag](./example/compflag): compflag shows how to use the github.com/posener/complete/v2/compflag package to have auto bash completion for a defined set of flags.
+
+* [example/stdlib](./example/stdlib): stdlib shows how to have flags bash completion to an arbitrary Go program that uses the standard library flag package.
+
* [gocomplete](./gocomplete): Package main is complete tool for the go command line
* [install](./install): Package install provide installation functions of command completion.
* [predict](./predict): Package predict provides helper functions for completion predictors.
-
---
-
-Created by [goreadme](https://github.com/apps/goreadme)
+Readme created from Go doc with [goreadme](https://github.com/posener/goreadme)