From 0af844501d9f1e17935ae893f4e39d88c274bed2 Mon Sep 17 00:00:00 2001 From: xerus2000 <27jf@pm.me> Date: Wed, 15 Apr 2020 18:56:55 +0200 Subject: [PATCH] docs(readme): clean up readme --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b877b46..63e77d2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # mpris-java -Simple [MPRIS 2.2](https://specifications.freedesktop.org/mpris-spec/2.2/) implementation with Kotlin for the JVM. -Code is basically done, but largely untested. No guarantees for it to work. +Simple [MPRIS 2.2](https://specifications.freedesktop.org/mpris-spec/2.2/) implementation with Kotlin for the JVM. +Code is basically done, but largely untested. No guarantees or liabilities - [MIT License](LICENSE). -A test implementation can be found in [extensions/test/xerus/mpris/MPRISPlayer.kt](extensions/test/xerus/mpris/MPRISPlayer.kt). +The project is separated into two modules, the base/root module and [mpris-extensions](extensions), which is meant to ease the use of this library by providing reference implementations and abstractions. While the base module should be compatible with any JVM language, the extensions module is specifically developed for Kotlin. -The project is separated into two modules, the base/root module and [mpris-extensions](extensions), which is meant to ease the use of this library by providing reference implementations and abstractions. - -The base module should be compatible with any JVM language, while the extensions module is specifically fitted to Kotlin. \ No newline at end of file +A test implementation can be found in [extensions/test/xerus/mpris/MPRISPlayer.kt](extensions/test/xerus/mpris/MPRISPlayer.kt), which should be executable from within your IDE after syncing with gradle via `./gradlew build`.