- readme update

duclong09 · Jan 10, 2019 · bc51230 · bc51230
1 parent 671c0f8
commit bc51230
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,14 @@
 Poweramp APIs
 ===========
 
-Please check https://forum.powerampapp.com/forum/13-developers-area/ for more details
-
-Also see [poweramp_skin_sdk/poweramp_skin_sample/readme.md](poweramp_skin_sdk/poweramp_skin_sample/readme.md)
-
+* **Skin SDK**: [poweramp_skin_sdk/poweramp_skin_sample/readme.md](poweramp_skin_sdk/poweramp_skin_sample/readme.md)
+* **Intent-based APIs**: [poweramp_api_example/readme.md](poweramp_api_example/readme.md)
+* **Visualization Presets**: [poweramp_vis_presets_example/readme.md](poweramp_vis_presets_example/readme.md)
+* **Loadable DSP Plugins**: TBD
+* **Album Art Loaders**: TBD
+* **Lyrics Loaders**: TBD
+* **Widgets (obsolete)**: [poweramp_simplewidgetpack](poweramp_simplewidgetpack)
+
+Also see https://forum.powerampapp.com/forum/13-developers-area/ for more details
 
 
diff --git a/poweramp_api_example/app/src/main/java/com/maxmpz/poweramp/apiexample/MainActivity.java b/poweramp_api_example/app/src/main/java/com/maxmpz/poweramp/apiexample/MainActivity.java
@@ -1,5 +1,5 @@
 /*
-Copyright (C) 2011-2018 Maksim Petrov
+Copyright (C) 2011-2019 Maksim Petrov
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted for widgets, plugins, applications and other software

diff --git a/poweramp_api_example/readme.md b/poweramp_api_example/readme.md
@@ -1,9 +1,9 @@
 # Poweramp Intent APIs Example
 ============================================
 
-This is an example project that demonstrates Poweramp v2 and v3 Intent based APIs. These APIs are focused on simplicity, you can just
-throw a simple Intent to Poweramp to play something, command Poweramp to do something, or get some Poweramp state from published Intents.
-While being simple, Intent APIs still provide almost complete control over Poweramp.
+This is an example project that demonstrates Poweramp v2 and v3 Intent based APIs. These APIs are focused on simplicity: you can just
+throw a simple Intent to Poweramp to play something, command Poweramp to do something, or get some Poweramp state from the published Intents.
+While being simple Intent APIs provide almost complete control over Poweramp.
 
 Please see: [../poweramp_api_lib/readme.md](../poweramp_api_lib/readme.md) for details. Also see comments/doc-comments in Example project source files.
 
diff --git a/poweramp_api_lib/readme.md b/poweramp_api_lib/readme.md
@@ -1,10 +1,11 @@
 # Poweramp Intent APIs
 ============================================
 
-Poweramp v2 and v3 Intent based APIs are focused on simplicity, you can just throw a simple Intent to Poweramp to play something, command Poweramp to do something, or get some Poweramp state from published Intents.
-While being simple, Intent APIs still provide almost complete control over Poweramp.
+Poweramp v2 and v3 Intent based APIs are focused on simplicity: you can just throw a simple Intent to Poweramp to play something, command Poweramp to do something,
+or get some Poweramp state from the published Intents.
+While being simple Intent APIs provide almost complete control over Poweramp.
 
-See [src/com/maxmpzp/poweramp/player/PowerampAPI.java](src/com/maxmpzp/poweramp/player/PowerampAPI.java) comments for reference.
+See [src/com/maxmpz/poweramp/player/PowerampAPI.java](src/com/maxmpz/poweramp/player/PowerampAPI.java) comments for reference.
 
 ### Other Relevant Poweramp APIs
 
@@ -20,11 +21,11 @@ See [src/com/maxmpzp/poweramp/player/PowerampAPI.java](src/com/maxmpzp/poweramp/
 * old Poweramp v3 builds (from Alphas to build 816) partially implements **MediaSession**:
   * current played track info is exposed
   * commands are processed only via *onMediaButtonEvent*
-* Poweramp supports querying its database via **content provider** with REST like URIs. Please see [src/com/maxmpzp/poweramp/player/PowerampAPI.java](src/com/maxmpzp/poweramp/player/PowerampAPI.java) for reference
+* Poweramp supports querying its database via **content provider** with REST like URIs. Please see [src/com/maxmpz/poweramp/player/PowerampAPI.java](src/com/maxmpz/poweramp/player/PowerampAPI.java) for reference
   * inaccurate data updates may corrupt Poweramp database or break Library consistency
   * **Android 8+**: permission should be requested from Poweramp: see *PowerampAPI.ACTION_ASK_FOR_DATA_PERMISSION*
-* Poweramp v3 exposes current playing track album art via **content://com.maxmpz.audioplayer.aa/** URIs. Album art is delivered in its original form as it is on
-  (*ParcelFileDescriptor* to either a cached image file or to an embedded album art)
+* Poweramp v3 exposes current playing track album art via **content://com.maxmpz.audioplayer.aa/** URIs. Album art is delivered in its original form "as is"
+  (*ParcelFileDescriptor* eitger to the cached image file or to the embedded album art)
   * Poweramp v3 (**build 817+**) also provides album art, artist, genres, etc. images for any "entity" (track, album, genre, artist, etc.) in their original form via REST like URIs.
     (These uris are used for MediaBrowserCompat resulting lists via *MediaBrowserCompat.MediaItem.getDescription().getIconUri()*)
 
diff --git a/poweramp_api_lib/src/com/maxmpz/poweramp/player/PowerampAPI.java b/poweramp_api_lib/src/com/maxmpz/poweramp/player/PowerampAPI.java
@@ -1,5 +1,5 @@
 /*
-Copyright (C) 2011-2018 Maksim Petrov
+Copyright (C) 2011-2019 Maksim Petrov
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted for widgets, plugins, applications and other software