~cypheon/livetools

257ef76fd09805624dd263e305edc48137a74239 — Johann Rudloff 1 year, 8 months ago 5b63655
Add documentation.
1 files changed, 33 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +33 -0
@@ 0,0 1,33 @@
# livetools: Live-updating Command Line Tools

This repo provides live-updating versions of the `wc` and `date` binaries,
designed for interactive use, called `lwc` and `ldate`.

The tools perform the same tasks as their standard *nix counterparts, but
provide periodic updates on the terminal.

## lwc

Count bytes/words/lines in standard input.

### Usage

    $ lwc [options]

Options:

    -c, --bytes         Print count of bytes
    -l, --lines         Print count of lines
    -w, --words         Print count of words
    -h, --help          Show usage

## ldate

Display current date and time.

### Usage

    $ ldate

This will display the current time updated once a second.  Currently, the
`ldate` does not support any command line flags.