Rewrote/Reformatted README.md

This commit is contained in:
Jan Christian Grünhage 2017-01-19 11:36:00 +01:00
parent bb2cd0cf80
commit 1cfa10bf88
Signed by: jcgruenhage
GPG key ID: 321A67D9EE8BC3E1

View file

@ -1,21 +1,38 @@
# Play Music Exporter
This Android app exports your Play Music mp3 files directly to your sdcard using root permissions.
This Android app exports your Play Music mp3 files directly to your sdcard
or a documents provider using root permissions.
You can also setup automatic export, that exports all currently cached not yet exported music.
## About
This AndroidStudio project allow you to access the database from Google's PlayMusic and also allows you to export the music files as mp3 to your sdcard. There is also a nice library you can simply use in your projects.
This AndroidStudio project allow you to access the database from Google's PlayMusic
and also allows you to export the music files as mp3 to your sdcard or a documents provider.
There is also a nice library you can simply use in your projects.
### Requirements
**This app and its library will require root access to your device! If your device is not rooted you can't use this app neither the lib.**
**This app and the included library will require root access to your device!
If your device is not rooted you can neither use this app nor the library.**
This project uses the [mp3agic library](https://github.com/mpatric/mp3agic) by [Michael Patricios (mpatric)](https://github.com/mpatric).
This app uses API Level 21, which has been introduced by Android Lollipop. If you use KitKat
or lower, this app will not work.
### Notice
### Credits
I recently forked this repository and most of the work has been done by [David Schulte](https://www.david-schulte.de/).
You can find his old/inactive repository [here](https://github.com/Arcus92/PlayMusicExporter).
This is a fork off [David Schulte's original project](https://github.com/Arcus92/PlayMusicExporter).
Most of the work has been done by him, me and the other collaborators just have improved his work
in some minor ways, like making the app more usable and configurable. The exporting itself, the hard
part, has been done by him.
This project uses the [mp3agic library](https://github.com/mpatric/mp3agic)
by [Michael Patricios (mpatric)](https://github.com/mpatric).
### Contributing
If you want to contribute to this project, fork off of develop,
implement what you want to implement, and submit a pull request back into develop.
After testing it, if enough of the collaborators like it, we will merge it.
### Copyright