Skip to content

Commit

Permalink
update readme rst
Browse files Browse the repository at this point in the history
  • Loading branch information
bjarneo committed May 12, 2016
1 parent 3e190b4 commit 7b731a9
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,38 @@
Pytify
=============

Search and start songs from command line.<br>
Should work in Linux and OS X.<br>
Supports both python 2 and 3. <br>
[![Code Climate](https://codeclimate.com/github/bjarneo/Pytify/badges/gpa.svg)](https://codeclimate.com/github/bjarneo/Pytify)

Search and start songs from the CLI.
Linux and OS X support.

Python 3 support. For Python 2 support use this release: [v2.1.0](https://github.com/bjarneo/Pytify/tree/v2.1.0)

![Image of terminal]
(http://i.imgur.com/zlt3f8P.gif)
(http://i.imgur.com/I1uvoVx.gif)


## Installation
```python
```bash
$ sudo pip install pytify
```

## Or clone the repo
```python
## Features
* Auto suggest (based on history)
* Search history
* Search and play songs
* CLI commands
* VIM navigation bindings

## Clone repo
```bash
$ git clone https://github.com/bjarneo/pytify.git
$ cd pytify
$ sudo python setup.py install
```

### Usage
```python
```bash
# To start the app type
$ pytify
Expand All @@ -38,7 +48,8 @@ $ pytify -pp

### Dependency
```bash
pip install requests gnureadline
* requests
* prompt-toolkit
```

### Contributing
Expand All @@ -49,5 +60,5 @@ Contributions are appreciated.
- [@adam410](https://github.com/adam410/) - OS X issue
- [@Newky](https://github.com/Newky) - Better structure
- [@ymski](https://github.com/ymski) - OS X
- [@wohlfea](https://github.com/wohlfea) - Make it compatible with python 3.5
- [@wohlfea](https://github.com/wohlfea) - Made it compatible with python 3.5
- [@ddiddi](https://github.com/ddiddi) - Added search phrase history browsing. (auto complete)

0 comments on commit 7b731a9

Please sign in to comment.