Skip to content

Commit

Permalink
update readme for packaging
Browse files Browse the repository at this point in the history
  • Loading branch information
simon-weber committed Mar 28, 2012
1 parent 2318ec8 commit 0407dd1
Showing 1 changed file with 11 additions and 17 deletions.
28 changes: 11 additions & 17 deletions README.md
Expand Up @@ -4,15 +4,18 @@ The project is not supported nor endorsed by Google. I'll be interning for Googl

**Respect Google in your use of the API**. Use common sense (protocol compliance, reasonable load, etc) and don't ruin the fun for everyone else.

For those looking to use the api, documentation is hosted at Read the Docs: [documentation](http://readthedocs.org/docs/unofficial-google-music-api/en/latest).
For those looking to use the api, see the usage section below. Documentation is hosted at Read the Docs: [documentation](http://readthedocs.org/docs/unofficial-google-music-api/en/latest).

For those looking to port or contribute, check out the code overview on the wiki: [wiki](https://github.com/simon-weber/Unofficial-Google-Music-API/wiki/Codebase-Overview). There's also a section on porting below.
For those looking to port or contribute, see the porting section below. There's also a code overview on the wiki: [wiki](https://github.com/simon-weber/Unofficial-Google-Music-API/wiki/Codebase-Overview).

For bugs reports, feature requests, and contributions, go ahead and [open an issue](https://github.com/simon-weber/Unofficial-Google-Music-API/issues/new).

##Features

**New in version 2012.03.27:** various bugfixes and internal enhancements
**New in version 2012.03.27:**

* proper pip packaging
* various bugfixes and internal enhancements

See the changelog for details.

Expand Down Expand Up @@ -45,26 +48,17 @@ See the changelog for details.

##Usage

gmusicapi.api.Api is the user-facing interface.
To get started, install the dependencies and see example.py. For more information, see the [documentation](http://readthedocs.org/docs/unofficial-google-music-api/en/latest) and testing code. In addition, Michal Odnous has built [an example](https://github.com/odiroot/Unofficial-Google-Music-API/blob/mo-sandbox/example_play.py) that will play songs from your library.

##Dependencies

The API has been tested on Python 2.7.2 on Linux.

Currently, the following third party modules are used:

* [decorator](http://pypi.python.org/pypi/decorator)
###Installation

* [mutagen](http://code.google.com/p/mutagen)
You can use `pip install gmusicapi` to get the most recent version and dependencies. If you don't have pip, see their [installation docs](http://www.pip-installer.org/en/latest/index.html).

* [protobuf](http://code.google.com/p/protobuf)
###Getting Started

* [validictory](http://pypi.python.org/pypi/validictory) 0.8.1+
gmusicapi.api.Api is the user-facing interface. The provided example.py should be enough to get you started. For more information, see the [documentation](http://readthedocs.org/docs/unofficial-google-music-api/en/latest) and testing code.

You can install these with pip. Alternatively, the first three are in Ubuntu's repos:

python-decorator python-mutagen python-protobuf
In addition, Michal Odnous has built [an example](https://github.com/odiroot/Unofficial-Google-Music-API/blob/mo-sandbox/example_play.py) that will play songs from your library.

##Porting

Expand Down

0 comments on commit 0407dd1

Please sign in to comment.