updated plugins.md docs

Author: Plamen5kov

PLUGINS.md

@@ -25,6 +25,7 @@ A NativeScript plugin is any npm package, published or not, that exposes a nativ
 * `AndroidManifest.xml` and `Info.plist` which describe the permissions, features or other configurations required or used by your app for Android and iOS, respectively.
 * (Optional) Native Android libraries.
 * (Optional) Native iOS dynamic libraries.
+* (Optional) Android include.gradle configurations file. (sugestion)
 
 The plugin must have the directory structure, described in the [Directory Structure](#directory-structure) section.
 
@@ -33,11 +34,12 @@ The plugin must have the directory structure, described in the [Directory Struct
 If the NativeScript framework does not expose a native API that you need, you can develop a plugin which exposes the required functionality. When you develop a plugin, keep in mind the following requirements.
 
 * The plugin must be a valid npm package.
-* The plugin must expose a built-in native API or a native API available via custom native libraries.
+* The plugin must expose a built-in native API or a native API available via custom native libraries. (why "must")
 * The plugin must be written in JavaScript or TypeScript and must comply with the CommonJS specification. If written in TypeScript, make sure to include the compiled `JavaScript` file in your plugin.
 * The plugin directory structure must comply with the specification described below.
 * The plugin must contain a valid `package.json` which complies with the specification described below.
 * If the plugin requires any permissions, features or other configuration specifics, it must contain `AndroidManifest.xml` and `Info.plist` file which describe them.
+* (android speciffic) If the plugin has native dependencies, it must contain include.gralde file, which describe them. (suggestion)
 
 ### Directory Structure
 
@@ -50,6 +52,7 @@ my-plugin/
 └── platforms/
     ├── android/
     │   └── AndroidManifest.xml
+    │   └── include.gradle  (suggestion)
     └── ios/
         └── Info.plist
 ```
@@ -68,13 +71,15 @@ my-plugin/
 └── platforms/
     ├── android/
     │   └── AndroidManifest.xml
+    │   └── include.gradle  (suggestion)
     └── ios/
         └── Info.plist
 ```
 
 * `index.js`: This file is the CommonJS module which exposes the native API. You can use platform-specific `*.platform.js` files. For example: `index.ios.js` and `index.android.js`. During the plugin installation, the NativeScript CLI will copy the platform resources to the `tns_modules` subdirectory in the correct platform destination in the `platforms` directory of your project.<br/>Alternatively, you can give any name to this CommonJS module. In this case, however, you need to point to this file by setting the `main` key in the `package.json` for the plugin. For more information, see [Folders as Modules](https://nodejs.org/api/modules.html#modules_folders_as_modules). 
 * `package.json`: This file contains the metadata for your plugin. It sets the supported runtimes, the plugin name and version and any dependencies. The `package.json` specification is described in detail below.
-* `platforms\android\AndroidManifest.xml`: This file describes any specific configuration changes required for your plugin to work. For example: required permissions. For more information about the format of `AndroidManifest.xml`, see [App Manifest](http://developer.android.com/guide/topics/manifest/manifest-intro.html).<br/>During the plugin installation, the NativeScript CLI will merge the plugin `AndroidManifest.xml` with the `AndroidManifest.xml` for your project. The NativeScript CLI will not resolve any contradicting or duplicate entries during the merge. After the plugin is installed, you need to manually resolve such issues. 
+* `platforms\android\AndroidManifest.xml`: This file describes any specific configuration changes required for your plugin to work. For example: required permissions. For more information about the format of `AndroidManifest.xml`, see [App Manifest](http://developer.android.com/guide/topics/manifest/manifest-intro.html).<br/>During the plugin installation, the NativeScript CLI will merge the plugin `AndroidManifest.xml` with the `AndroidManifest.xml` for your project. The NativeScript CLI will not resolve any contradicting or duplicate entries during the merge. After the plugin is installed, you need to manually resolve such issues.
+* `platforms\android\include.gradle': This file can change the native configuration.For example native dependencies, build types and configurations. For more information about the format of 'include.gradle', see [include.gradle file](#includegradle-specification).  (remove) .<br/>During the plugin installation, the NativeScript CLI will merge the plugin `AndroidManifest.xml` with the `AndroidManifest.xml` for your project. (remove) (suggestion)
 * `platforms\ios\Info.plist`: This file describes any specific configuration changes required for your plugin to work. For example: required permissions. For more information about the format of `Info.plist`, see [About Information Property List Files](https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html).<br/>During the plugin installation, the NativeScript CLI will merge the plugin `Info.plist` with the `Info.plist` for your project. The NativeScript CLI will not resolve any contradicting or duplicate entries during the merge. After the plugin is installed, you need to manually resolve such issues. 
 
 NativeScript plugins which contain both native Android and iOS libraries might have the following directory structure.
@@ -84,19 +89,21 @@ my-plugin/
 ├── ...
 └── platforms/
     ├── android/
-    │   ├── libs/
-    │   │   └── MyLibrary.jar
-    │   ├── MyAndroidLibrary/
-    │   │   ├── ...
-    │   │   └── project.properties
+    │   ├── libs/ (remove suggestion)
+    │   │   └── MyLibrary.jar (remove suggestion)
+    │   ├── MyAndroidLibrary/  (remove suggestion)
+    │   │   ├── ... (remove suggestion)
+    │   │   └── project.properties (remove suggestion)
+    │   └── MyLibrary.jar (add suggestion)
+    │   └── include.gradle (add suggestion)
     │   └── AndroidManifest.xml
     └── ios/
         ├── MyiOSLibrary.framework
         └── Info.plist
 ```
 
-* `platforms\android\libs`: This directory contains any native Android libraries packaged as `*.jar` packages. During the plugin installation, the NativeScript CLI will copy these files to `lib\Android` in your project and will configure the Android project in `platforms\android` to work with the library.
-* `platforms\android\MyAndroidLibrary`: This directory contains a native Android library with a `project.properties` file. During the plugin installation, the NativeScript CLI will copy these files to `lib\Android` in your project and will configure the Android project in `platforms\android` to work with the library.
+* `platforms\android\libs`: This directory contains any native Android libraries packaged as `*.jar` packages. During the plugin installation, the NativeScript CLI will copy these files to `lib\Android` in your project and will configure the Android project in `platforms\android` to work with the library. (remove suggestion)
+* `platforms\android\MyAndroidLibrary`: This directory contains a native Android library with a `project.properties` file. During the plugin installation, the NativeScript CLI will copy these files to `lib\Android` in your project and will configure the Android project in `platforms\android` to work with the library. (remove suggestion)
 * `platforms\ios`: This directory contains native iOS dynamic libraries (`.framework`). During the plugin installation, the NativeScript CLI will copy these files to `lib\iOS` in your project and will configure the Android project in `platforms\ios` to work with the library.
 
 ### Package.json Specification
@@ -124,6 +131,31 @@ The following is an example of a `package.json` file for a NativeScript plugin w
 }
 ```
 
+### Include.gradle Specification
+
+* The include.gradle file must contain it's own configuration.
+* The include.gradle file can optionally contain native dependencies it needs to build correctly.
+* If you have native dependencies be sure they can be found in [jcenter](https://bintray.com/bintray/jcenter).
+* If you haven't got an include.gradle file in the specified place, a default one will be created at build time, including all default elements.
+
+#### Include.gradle Example
+
+```
+//default
+android { 
+	productFlavors {
+		"plugin-name" {
+			dimension "plugin-name"
+		}
+	}
+}
+
+//optional
+dependencies {
+    compile "groupName:pluginName:ver"
+}
+```
+
 ## Install a Plugin
 
 To install a plugin for your project, inside your project, run the following command.
@@ -148,15 +180,15 @@ The installation of a NativeScript plugin mimics the installation of an npm modu
 
 The NativeScript CLI takes the plugin and installs it to the `node_modules` directory in the root of your project. During this process, the NativeScript CLI resolves any dependencies described in the plugin `package.json` file and adds the plugin to the project `package.json` file in the project root.
 
-If the NativeScript CLI detects any native libraries in the plugin, it copies the library files to the `lib/<platform>` folder in your project and configures the platform-specific projects in `platforms/<platform>` to work with the library.
+If the NativeScript CLI detects any native libraries in the plugin, it copies the library files to the `lib/<platform>` folder in your project and configures the platform-specific projects in `platforms/<platform>` to work with the library. (remove suggestion)
 
 Next, the NativeScript CLI runs a partial `prepare` operation for the plugin for all platforms configured for the project. During this operation, the CLI copies only the plugin to the `tns_modules` subdirectories in the `platforms\android` and `platform\ios` directories in your project. If your plugin contains platform-specific `JS` files, the CLI copies them to the respective platform subdirectory and renames them by removing the platform modifier. 
 
-> **TIP:** If you have not configured any platforms, when you run `$ tns platform add`, the NativeScript CLI will automatically prepare all installed plugins for the selected platform.
+> **TIP:** If you have not configured any platforms, when you run `$ tns platform add`, the NativeScript CLI will automatically prepare all installed plugins for the selected platform. (suggestion - remove or explain better)
 
-Finally, the CLI merges the plugin `AndroidManifest.xml` and `Info.plist` files with `platforms\android\AndroidManifest.xml` and `platforms\ios\Info.plist` in your project.
+Finally, the CLI merges the plugin `AndroidManifest.xml` and `Info.plist` files with `platforms\android\AndroidManifest.xml` and `platforms\ios\Info.plist` in your project. (remove suggestion - it doesn't merge anymore)
 
-> **IMPORTANT:** Currently, the merging of the platform configuration files does not resolve any contradicting or duplicate entries.
+> **IMPORTANT:** Currently, the merging of the platform configuration files does not resolve any contradicting or duplicate entries. (remove suggestion - it does with 1.5)
 
 #### AndroidManifest.xml Merge Example
 
@@ -281,13 +313,13 @@ You must specify the plugin by the value for the `name` key in the plugin `packa
 
 The removal of a NativeScript plugin mimics the removal of an npm module.
 
-The NativeScript CLI removes any plugin files from the `node_modules` directory in the root of your project and removes any native Android libraries which have been added during the plugin installation. During this process, the NativeScript CLI removes any dependencies described in the plugin `package.json` file and removes the plugin from the project `package.json` file in the project root.
+The NativeScript CLI removes any plugin files from the `node_modules` directory in the root of your project and removes any native Android libraries which have been added during the plugin installation (remove suggestion). During this process, the NativeScript CLI removes any dependencies described in the plugin `package.json` file and removes the plugin from the project `package.json` file in the project root.
 
-> **IMPORTANT:** This operation does not remove files from the `platforms\android` and `platforms\ios` directories and native iOS libraries, and does not unmerge the `AndroidManifest.xml` and `Info.plist` files. 
+> **IMPORTANT:** This operation does not remove files from the `platforms\android` and `platforms\ios` directories and native iOS libraries, and does not unmerge the `AndroidManifest.xml` and `Info.plist` files. (remove suggestion - it does with 1.5)
 
 ### Manual Steps After Removal
 
-After the plugin removal is complete, make sure to remove any leftover native library files from the `<lib>` directory in the root of the project.Update the platform-specific projects in `platforms\<platform>` to remove any dependencies on the removed native libraries.
+After the plugin removal is complete, make sure to remove any leftover native library files from the `<lib>` directory in the root of the project.Update the platform-specific projects in `platforms\<platform>` to remove any dependencies on the removed native libraries. (remove suggestion)
 
 Next, you need to run the following command.
 
@@ -299,6 +331,6 @@ Make sure to run the command for all platforms configured for the project. Durin
 
 > **TIP:** Instead of `$ tns prepare` you can run `$ tns build`, `$ tns run`, `$ tns deploy` or `$ tns emulate`. All these commands run `$ tns prepare`.
 
-Next, open your `platforms\android\AndroidManifest.xml` and `platforms\ios\Info.plist` files and remove any leftover entries from the plugin `AndroidManifest.xml` and `Info.plist` files.
+Next, open your `platforms\android\AndroidManifest.xml` and `platforms\ios\Info.plist` files and remove any leftover entries from the plugin `AndroidManifest.xml` and `Info.plist` files. (remove suggestion)
 
 Finally, make sure to update your code not to use the uninstalled plugin.