diff --git a/README.md b/README.md new file mode 100644 index 0000000..15065ad --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# bindown + +**bindown** is a command-line utility to download, verify and install binary files. It is intended to be used in +development and ci environments where it is important to guarantee the same version of the same binary is downloaded +every time. + +## Usage + +``` + Usage: bindown + +Flags: + --help Show context-sensitive help. + --configfile="buildtools.json" file with tool definitions + --cellar-dir=STRING directory where downloads will be cached + +Commands: + version + + download + download a bin + + config format + formats the config file + + config update-checksums + name of the binary to update + + config validate + validate that downloads work + +Run "bindown --help" for more information on a command. +```