Merge pull request #4 from Senzing/3.dockter.1

3.dockter.1
senzing-garage · Jul 21, 2023 · efda0ab · efda0ab
2 parents 9f90b09 + 300cc15
commit efda0ab
Show file tree

Hide file tree

Showing 33 changed files with 858 additions and 500 deletions.
diff --git a/.gitignore b/.gitignore
@@ -19,3 +19,4 @@
 
 # Go workspace file
 go.work
+.history
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,21 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-- Thing 5
-- Thing 4
+-
 
-## [1.0.1] - yyyy-mm-dd
+## [0.1.0] - 2023-07-21
 
-### Added to 1.0.1
+### Added to 0.1.0
 
-- Thing 3
-
-### Fixed in 1.0.1
-
-- Thing 2
-
-## [1.0.0] - yyyy-mm-dd
-
-### Added to 1.0.0
-
-- Thing 1
+- Initial functionality: cmdhelper, constant, and option packages.
diff --git a/README.md b/README.md
@@ -1,2 +1,42 @@
 # go-cmdhelping
-Helpers for using cobra and viper
+
+## :warning: WARNING: go-cmdhelping is still in development :warning: _
+
+At the moment, this is "work-in-progress" with Semantic Versions of `0.n.x`.
+Although it can be reviewed and commented on,
+the recommendation is not to use it yet.
+
+## Synopsis
+
+`go-cmdhelping` contains utility packages for working with
+[viper](https://github.com/spf13/viper) and
+[cobra](https://github.com/spf13/cobra)
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/senzing/go-cmdhelping.svg)](https://pkg.go.dev/github.com/senzing/go-cmdhelping)
+[![Go Report Card](https://goreportcard.com/badge/github.com/senzing/go-cmdhelping)](https://goreportcard.com/report/github.com/senzing/go-cmdhelping)
+[![go-test.yaml](https://github.com/Senzing/go-cmdhelping/actions/workflows/go-test.yaml/badge.svg)](https://github.com/Senzing/go-cmdhelping/actions/workflows/go-test.yaml)
+[![License](https://img.shields.io/badge/License-Apache2-brightgreen.svg)](https://github.com/Senzing/go-cmdhelping/blob/main/LICENSE)
+
+## Overview
+
+`go-cmdhelping` is an opinionated use of
+[viper](https://github.com/spf13/viper) and
+[cobra](https://github.com/spf13/cobra).
+
+Context variables are specified in a list of
+[option.ContextVariable](option/option.go).
+
+The `[]option.ContextVariable` list is processed by functions in the
+[cmdhelper](cmdhelper) package.
+
+## Use
+
+See
+[main.go](main.go)
+for an example of use.
+
+## References
+
+- [Development](docs/development.md)
+- [Errors](docs/errors.md)
+- [Examples](docs/examples.md)
diff --git a/cmd/cmd_test.go b/cmd/cmd_test.go
diff --git a/cmd/completion.go b/cmd/completion.go
diff --git a/cmd/context_darwin.go b/cmd/context_darwin.go
diff --git a/cmd/context_linux.go b/cmd/context_linux.go
diff --git a/cmd/context_windows.go b/cmd/context_windows.go
diff --git a/cmd/doc.go b/cmd/doc.go
diff --git a/cmd/docs.go b/cmd/docs.go
diff --git a/cmd/github.go b/cmd/github.go
diff --git a/cmd/root.go b/cmd/root.go