Skip to content

Commit

Permalink
docs(readme): clean up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xeruf committed Apr 15, 2020
1 parent 66840b1 commit 0af8445
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
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`.

0 comments on commit 0af8445

Please sign in to comment.