(#12) Update CHANGELOG and code docs

Author: LaksCastro

CHANGELOG.md

@@ -4,12 +4,31 @@ Major release focused on support for `Storage Access Framework`.
 
 ### Breaking Changes
 
-- New `minSdkVersion` set to `19`.
-- `getMediaStoreContentDirectory` return type set to `Uri`.
+- `minSdkVersion` set to `19`.
+- `getMediaStoreContentDirectory` return type changed to `Uri`.
+- Import package directive path is now modular. Which means you need to import the modules you are using:
+  - `import 'package:shared_storage/saf.dart' as saf;` to enable **Storage Access Framework** API.
+  - `import 'package:shared_storage/environment.dart' as environment;` to enable **Environment** API.
+  - `import 'package:shared_storage/media_store.dart' as mediastore;` to enable **Media Store** API.
+  - `import 'package:shared_storage/shared_storage' as sharedstorage;` if you want to import all above and as a single module (Not recommended because can conflict/override names/methods).
+
+### New Features
+
+- <samp>Mirror</samp> `createFile` from [DocumentFile.createFile()](<https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#createFile(java.lang.String,%20java.lang.String)>). Create a child file from given a parent uri.
+
+- <samp>Mirror</samp> `child` from [DocumentFile.child()](<https://developer.android.com/reference/androidx/documentfile/provider/DocumentFile#createFile(java.lang.String,%20java.lang.String)>). Find the child file of a given parent uri and child name, null if doesn't exists.
+
+- <samp>Original `UNSTABLE`</samp> `openDocumentFile`. Open a file uri in a external app, by starting a new activity with `ACTION_VIEW` Intent.
+
+- <samp>Original `UNSTABLE`</samp> `getRealPathFromUri`. Return the real path to work with native old `File` API instead Uris, be aware this approach is no longer supported on Android 10+ (API 29+) and though new, this API is **marked as deprecated** and should be migrated to a _scoped-storage_ approach.
+
+- <samp>Alias</samp> `getDocumentContentAsString`. Alias for `getDocumentContent` and convert all bytes into `String`.
+
+-
 
 ### Deprecation Notices
 
-- `getExternalStoragePublicDirectory` was marked as deprecated and should be replaced with an equivalent API depending on your use-case, see [how to migrate `getExternalStoragePublicDirectory`](https://stackoverflow.com/questions/56468539/getexternalstoragepublicdirectory-deprecated-in-android-q).
+- `getExternalStoragePublicDirectory` was marked as deprecated and should be replaced with an equivalent API depending on your use-case, see [how to migrate `getExternalStoragePublicDirectory`](https://stackoverflow.com/questions/56468539/getexternalstoragepublicdirectory-deprecated-in-android-q). This deprecation is originated from official Android documentation and not by the plugin itself.
 
 ## 0.2.0
 

android/src/main/kotlin/io/lakscastro/sharedstorage/storageaccessframework/DocumentFileHelperApi.kt

@@ -29,10 +29,10 @@ import io.lakscastro.sharedstorage.storageaccessframework.lib.*
  * natively by Android.
  *
  * This is why it is separated from the original and raw `DocumentFileApi` which is the class that
- * only exposes the APIs without modifying them
+ * only exposes the APIs without modifying them (Mirror API).
  *
  * Then here is where we can implement the main abstractions/use-cases which would be available
- * globally without modifying the strict APIs
+ * globally without modifying the strict APIs.
  */
 internal class DocumentFileHelperApi(private val plugin: SharedStoragePlugin) :
     MethodChannel.MethodCallHandler,

docs/Usage/Storage Access Framework.md

@@ -90,6 +90,19 @@ final Stream<PartialDocumentFile> onNewFileLoaded = documentFileOfMyGrantedUri.l
 onNewFileLoaded.listen((file) => files.add(file), onDone: () => print('All files were loaded'));
 ```
 
+### <samp>getRealPathFromUri</samp>
+
+Helper method to generate the file path of the given `uri`.
+
+See [Get real path from URI, Android KitKat new storage access framework](https://stackoverflow.com/questions/20067508/get-real-path-from-uri-android-kitkat-new-storage-access-framework/20559175#20559175) for details.
+
+```dart
+/// Any valid Uri.
+final Uri myUri = ...;
+
+final String? file = await getRealPathFromUri(myUri);
+```
+
 ## Mirror methods
 
 Mirror methods are available to provide an way to call a native method without using any abstraction, available mirror methods:

lib/shared_storage.dart

@@ -0,0 +1,3 @@
+export './environment.dart';
+export './media_store.dart';
+export './saf.dart';