Skip to content

Commit

Permalink
Add instructions in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aktech committed Apr 19, 2016
1 parent ab898da commit d7834bb
Showing 1 changed file with 50 additions and 2 deletions.
52 changes: 50 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,52 @@
Cricket Live : criclive
========================
# Cricket Live : `criclive`


Cricket Live: Get Live scores of all cricket matches in your Command Line.


[![PyPI version](https://img.shields.io/pypi/v/criclive.svg)](https://pypi.python.org/pypi/criclive)
[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)

![GIF Tutorial](criclive.gif)

# Install

## Using pip

```
pip install criclive
```

## Using Git

```
git clone https://github.com/aktech/criclive.git
cd criclive
python setup.py install
```

# Usage

Simply run the following command:
```
criclive
```
* Sample scores:

```
amit@aktech$ criclive
1. Kings XI Punjab ['138/8 (20 ov)'] VS Kolkata Knight Riders []
2. Nottinghamshire ['242 & 133/5 (68.5 ov)'] VS Lancashire ['332']
3. Middlesex ['452 & 20/2 (7 ov)'] VS Warwickshire ['468']
4. Yorkshire ['593/9d'] VS Hampshire ['372/7 (130.5 ov)']
5. Glamorgan ['348 & 74/3 (24.4 ov)'] VS Leicestershire ['427']
6. Derbyshire ['444'] VS Gloucestershire ['467/6 (110.5 ov)']
7. Sussex ['360 & 199/4 (43.1 ov)'] VS Essex ['320']
8. Balochistan ['215 (46.2/50 ov)'] VS Punjab (Pakistan) ['56/2 (18.1/50 ov)']
9. Somerset ['370/6d & 480/9d'] VS Cardiff MCCU ['118 & 134/8 (49.2 ov, target: 733)']
10. Krira U18 ['295'] VS Dhaka Metro Under-18s ['2/0 (1 ov)']
```

# Contributing

Use github's Pull request/issues feature for all contributions.

0 comments on commit d7834bb

Please sign in to comment.