diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4bfb38 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Asciinema + +[![Build Status](https://travis-ci.org/sickill/asciinema.png?branch=master)](https://travis-ci.org/sickill/asciinema) + +Command line client for [asciinema.org](http://asciinema.org) service. + +## Installation + +Download the tarball and install it with: + + wget -O asciinema-0.9.3.tar.gz https://github.com/sickill/asciinema/archive/v0.9.3.tar.gz + tar -xzvf asciinema-0.9.3.tar.gz + cd asciinema-0.9.3/ + sudo make install + +## Usage + +Check the available commands and options with: + + asciinema -h + +## License + +This project is released under MIT license. See [LICENSE.txt](LICENSE.txt).