From d730fe65f61f2f66471aaeb71048954f813c017a Mon Sep 17 00:00:00 2001 From: mappu Date: Mon, 31 Dec 2018 18:13:06 +1300 Subject: [PATCH] doc: top-level README --- _dist/README.txt => README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) rename _dist/README.txt => README.md (77%) diff --git a/_dist/README.txt b/README.md similarity index 77% rename from _dist/README.txt rename to README.md index 9105e4f..f9e92d2 100644 --- a/_dist/README.txt +++ b/README.md @@ -1,27 +1,24 @@ +# webcmd + A web-based interface for arbitrary command-line tools. Configure the possible options for your command (e.g. optional flags, custom arguments) and then remotely invoke the tool via a web interface. The web interface displays stdout/stderr of recent and in-progress tasks, and can cancel a long-running command at any time. -Written in Golang +## Usage -=USAGE= - -`Usage of ./webcmd: +``` +Usage of ./webcmd: -config string Path to configuration file (default "webcmd.conf") -version - Display version number and exit` + Display version number and exit +``` -=CONFIGURATION= +## Configuration See the included `webcmd.conf-sample` file for an example configuration implementing a Looking Glass server over the top of `/bin/ping`. -=GO GET= - -This package can be installed via go get: `go get code.ivysaur.me/webcmd` -[go-get]code.ivysaur.me/webcmd git https://git.ivysaur.me/code.ivysaur.me/webcmd.git[/go-get] - -=CHANGELOG= +## Changelog 2017-03-27 1.0.1 - Enhancement: Simplify configuration file format, allow parsing const strings directly