Add basic readme file

This commit is contained in:
Marcin Kulik
2013-10-03 17:57:40 +02:00
parent d31ffad536
commit cb68b49eb2

24
README.md Normal file
View File

@@ -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).