continuous-integration/drone/push Build is passing
Details
|
9 months ago | |
---|---|---|
.chglog | 9 months ago | |
cli | 9 months ago | |
cmd/greeting | 9 months ago | |
internal | 9 months ago | |
tests | 9 months ago | |
tools | 9 months ago | |
.drone.yml | 9 months ago | |
.gitignore | 9 months ago | |
.goreleaser.yml | 9 months ago | |
CHANGELOG.md | 9 months ago | |
LICENSE | 9 months ago | |
Makefile | 9 months ago | |
README.md | 9 months ago | |
go.mod | 9 months ago | |
go.sum | 9 months ago | |
preflight.sh | 9 months ago |
README.md
greeting - Hello World!
greeting
is a command-line (CLI) application that implements a traditional
"Hello World" greeting and is used as the basic of new command-line (CLI)
applications. Included are a project infrastructure for building, releaseing
and performing integration tests with coverage.
Features:
- Drone CI for continious integration
- GoReleaser for Releases
- Full e2e integration test suite using go-cmdtest
- Documentation
- License
Getting Started
Install from Releases
You can install greeting
by simply downloading the latest version from the
Release page for your platform
and placing the binary in your $PATH
.
Install from Source
To install greeting
from source you can run go get
directly if you have a
Go environment setup:
go get git.mills.io/prologic/greeting
NOTE: Be sure to have
$GOBIN
(if not empty) or your$GOPATH/bin
in your$PATH
. See Compile and install packages and dependencies
Or grab the source code and build:
git clone https://git.mills.io/prologic/greeting.git
cd greeting
make build
And optionally run make install
to place the binary greeting
in your $GOBIN
or $GOPATH/bin
(again see note above).
Usage
$ greeting
Hello? Anyone?
With a name:
$ greeting --name World
Hello World!
See greeting --help
for usage:
$ ./greeting --help
NAME:
cli - CLI app
USAGE:
greeting [global options] command [command options] [arguments...]
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--name value User name
--help, -h show help
Contributing
Interested in contributing to this project? You are welcome! Here are some ways you can contribute:
- File an Issue -- For a bug, or interesting idea you have for a new feature or just general questions.
- Submit a Pull-Request or two! We welcome all PR(s) that improve the project!
Please see the Contributing Guidelines.
License
greeting
is licensed under the terms of the MIT License