Files
asciinema/README.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2013-10-03 17:57:40 +02:00
# Asciinema
2014-08-05 16:26:27 +02:00
[![PyPI version](https://badge.fury.io/py/asciinema.png)](http://badge.fury.io/py/asciinema)
[![Build Status](https://travis-ci.org/asciinema/asciinema-cli.svg?branch=master)](https://travis-ci.org/asciinema/asciinema-cli) [![Downloads](https://pypip.in/d/asciinema/badge.png)](https://pypi.python.org/pypi/asciinema)
2013-10-03 17:57:40 +02:00
2014-02-09 14:05:55 +01:00
Command line client for [asciinema.org](https://asciinema.org) service.
2013-10-03 17:57:40 +02:00
## Installation
The latest __stable version__ of asciinema can always be installed or updated
to via [pip](http://www.pip-installer.org/en/latest/index.html) (prefered) or
easy\_install:
2013-10-03 19:15:15 +02:00
2014-08-05 16:26:27 +02:00
```bash
$ sudo pip install --upgrade asciinema
````
2013-10-03 19:15:15 +02:00
Alternatively:
2014-08-05 16:26:27 +02:00
```bash
$ sudo easy_install asciinema
```
2013-10-03 19:15:15 +02:00
Or, you can install the __development version__ directly from GitHub:
2013-10-03 19:15:15 +02:00
2014-08-05 16:26:27 +02:00
```bash
$ sudo pip install --upgrade https://github.com/sickill/asciinema/tarball/master
```
2013-10-03 17:57:40 +02:00
See [installation docs](https://asciinema.org/docs/installation) for more
options (Ubuntu, Fedora, Arch, Gentoo etc).
2013-10-03 17:57:40 +02:00
## Usage
Check the available commands and options with:
2014-08-05 16:26:27 +02:00
```bash
$ asciinema -h
```
2013-10-03 17:57:40 +02:00
2013-12-03 20:15:47 +01:00
## Contributing
If you want to contribute to this project check out
2014-02-09 14:05:55 +01:00
[Contributing](https://asciinema.org/contributing) page.
2013-12-03 20:15:47 +01:00
2013-10-06 12:58:29 +02:00
## Authors
2013-10-03 17:57:40 +02:00
2013-10-06 12:58:29 +02:00
Developed with passion by [Marcin Kulik](http://ku1ik.com) and great open
source [contributors](https://github.com/sickill/asciinema/contributors)
## Copyright
Copyright © 2011-2013 Marcin Kulik. See LICENSE.txt for details.