diff --git a/circle.yml b/circle.yml index 47b860012..331652216 100644 --- a/circle.yml +++ b/circle.yml @@ -25,4 +25,3 @@ deployment: branch: master commands: - ./scripts/docs/update_docs.sh - - ./scripts/docs/update_readmes.sh diff --git a/package.json b/package.json index 1b7592fd6..88ef2b881 100644 --- a/package.json +++ b/package.json @@ -57,7 +57,7 @@ "build:core": "tsc -p scripts/build/tsconfig-core.json", "build:utils": "tsc -p scripts/build/tsconfig-utils.json", "build:modules": "node scripts/build/build.js", - "shipit": "npm run build && npm run npmpub", + "shipit": "npm run build && gulp readmes && npm run npmpub", "npmpub": "sh scripts/build/publish.sh", "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0", "plugin:create": "gulp plugin:create" diff --git a/scripts/config.json b/scripts/config.json index 3ea0d4e91..8b4b8a512 100644 --- a/scripts/config.json +++ b/scripts/config.json @@ -2,5 +2,5 @@ "sitePath": "../ionic-site", "v2DocsDir": "docs/v2/native", "docsDest": "../ionic-site/content/docs/v2/native", - "pluginDir": "src/@ionic-native/plugins" + "pluginDir": "dist/packages-dist/@ionic-native/plugins" } diff --git a/scripts/docs/dgeni-readmes-config.js b/scripts/docs/dgeni-readmes-config.js index d5f0cae58..a894f5ad5 100644 --- a/scripts/docs/dgeni-readmes-config.js +++ b/scripts/docs/dgeni-readmes-config.js @@ -147,7 +147,7 @@ module.exports = function(currentVersion) { // Configure file writing .config(function(writeFilesProcessor) { - writeFilesProcessor.outputFolder = './' + config.pluginDir; + writeFilesProcessor.outputFolder = './dist/packages-dist/'; }) // Configure rendering diff --git a/scripts/docs/processors/readmes.js b/scripts/docs/processors/readmes.js index c2e220a03..3030e5d27 100644 --- a/scripts/docs/processors/readmes.js +++ b/scripts/docs/processors/readmes.js @@ -14,6 +14,7 @@ module.exports = function jekyll(renderDocsProcessor) { docs.forEach(function(doc, i) { doc.npmId = doc.outputPath.replace('/README.md', ''); + doc.outputPath = doc.outputPath.replace('src/', ''); }); // returning docs will replace docs object in the next process diff --git a/src/@ionic-native/plugins/3dtouch/readme.md b/src/@ionic-native/plugins/3dtouch/readme.md deleted file mode 100644 index f12539e97..000000000 --- a/src/@ionic-native/plugins/3dtouch/readme.md +++ /dev/null @@ -1,28 +0,0 @@ - - - Improve this doc - - -# 3DTouch - - -``` -$ npm install @ionic-native/3dtouch --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/3dtouch/) - -Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-3dtouch](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch) - - - - - -## Supported platforms - -- iOS - - - - - diff --git a/src/@ionic-native/plugins/actionsheet/readme.md b/src/@ionic-native/plugins/actionsheet/readme.md deleted file mode 100644 index fff564b9e..000000000 --- a/src/@ionic-native/plugins/actionsheet/readme.md +++ /dev/null @@ -1,32 +0,0 @@ - - - Improve this doc - - -# Action Sheet - - -``` -$ npm install @ionic-native/actionsheet --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/actionsheet/) - -Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-actionsheet](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet) - - -The ActionSheet plugin shows a native list of options the user can choose from. - -Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see the [ActionSheet plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet). - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/admob/readme.md b/src/@ionic-native/plugins/admob/readme.md deleted file mode 100644 index 9d11f1ced..000000000 --- a/src/@ionic-native/plugins/admob/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# AdMob - - -``` -$ npm install @ionic-native/admob --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/admob/) - -Cordova Repo: [https://github.com/floatinghotpot/cordova-admob-pro](https://github.com/floatinghotpot/cordova-admob-pro) - - -Plugin for Google Ads, including AdMob / DFP (doubleclick for publisher) and mediations to other Ad networks. - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/android-fingerprint-auth/readme.md b/src/@ionic-native/plugins/android-fingerprint-auth/readme.md deleted file mode 100644 index 3e7af48e7..000000000 --- a/src/@ionic-native/plugins/android-fingerprint-auth/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Android Fingerprint Auth - - -``` -$ npm install @ionic-native/android-fingerprint-auth --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/android-fingerprint-auth/) - -Cordova Repo: [https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth](https://github.com/mjwheatley/cordova-plugin-android-fingerprint-auth) - - -This plugin will open a native dialog fragment prompting the user to authenticate using their fingerprint. If the device has a secure lockscreen (pattern, PIN, or password), the user may opt to authenticate using that method as a backup. - - - diff --git a/src/@ionic-native/plugins/appavailability/readme.md b/src/@ionic-native/plugins/appavailability/readme.md deleted file mode 100644 index 0d7d5d0fe..000000000 --- a/src/@ionic-native/plugins/appavailability/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# App Availability - - -``` -$ npm install @ionic-native/appavailability --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/appavailability/) - -Cordova Repo: [https://github.com/ohh2ahh/AppAvailability](https://github.com/ohh2ahh/AppAvailability) - - -This plugin allows you to check if an app is installed on the user's device. It requires an URI Scheme (e.g. twitter://) on iOS or a Package Name (e.g com.twitter.android) on Android. - -Requires Cordova plugin: cordova-plugin-appavailability. For more info, please see the [AppAvailability plugin docs](https://github.com/ohh2ahh/AppAvailability). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/apprate/readme.md b/src/@ionic-native/plugins/apprate/readme.md deleted file mode 100644 index 4056c8284..000000000 --- a/src/@ionic-native/plugins/apprate/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# App Rate - - -``` -$ npm install @ionic-native/apprate --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/apprate/) - -Cordova Repo: [https://github.com/pushandplay/cordova-plugin-apprate](https://github.com/pushandplay/cordova-plugin-apprate) - - -The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never. - -Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [AppRate plugin docs](https://github.com/pushandplay/cordova-plugin-apprate). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/appversion/readme.md b/src/@ionic-native/plugins/appversion/readme.md deleted file mode 100644 index fa07f5525..000000000 --- a/src/@ionic-native/plugins/appversion/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# App Version - - -``` -$ npm install @ionic-native/appversion --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/appversion/) - -Cordova Repo: [https://github.com/whiteoctober/cordova-plugin-app-version](https://github.com/whiteoctober/cordova-plugin-app-version) - - -Reads the version of your app from the target build settings. - -Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see the [Cordova App Version docs](https://github.com/whiteoctober/cordova-plugin-app-version). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/background-geolocation/readme.md b/src/@ionic-native/plugins/background-geolocation/readme.md deleted file mode 100644 index 3aecd0bb6..000000000 --- a/src/@ionic-native/plugins/background-geolocation/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# BackgroundGeolocation - - -``` -$ npm install @ionic-native/background-geolocation --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/background-geolocation/) - -Cordova Repo: [https://github.com/mauron85/cordova-plugin-background-geolocation](https://github.com/mauron85/cordova-plugin-background-geolocation) - - -This plugin provides foreground and background geolocation with battery-saving "circular region monitoring" and "stop detection". For -more detail, please see https://github.com/mauron85/cordova-plugin-background-geolocation - - -## Supported platforms - -- iOS -- Android -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/backgroundmode/readme.md b/src/@ionic-native/plugins/backgroundmode/readme.md deleted file mode 100644 index a26fcdb5e..000000000 --- a/src/@ionic-native/plugins/backgroundmode/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# Background Mode - - -``` -$ npm install @ionic-native/backgroundmode --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/backgroundmode/) - -Cordova Repo: [https://github.com/katzer/cordova-plugin-background-mode](https://github.com/katzer/cordova-plugin-background-mode) - - -Cordova plugin to prevent the app from going to sleep while in background. -Requires Cordova plugin: cordova-plugin-background-mode. For more info about plugin, vist: https://github.com/katzer/cordova-plugin-background-mode - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/backlight/readme.md b/src/@ionic-native/plugins/backlight/readme.md deleted file mode 100644 index 14134d7c0..000000000 --- a/src/@ionic-native/plugins/backlight/readme.md +++ /dev/null @@ -1,34 +0,0 @@ - - - Improve this doc - - -# Backlight - - -
- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/backlight --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/backlight/) - -Cordova Repo: [https://github.com/mebibou/cordova-plugin-backlight](https://github.com/mebibou/cordova-plugin-backlight) - - -This plugin adds turning on/off the device backlight. - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/badge/readme.md b/src/@ionic-native/plugins/badge/readme.md deleted file mode 100644 index e0a1d2f1e..000000000 --- a/src/@ionic-native/plugins/badge/readme.md +++ /dev/null @@ -1,35 +0,0 @@ - - - Improve this doc - - -# Badge - - -``` -$ npm install @ionic-native/badge --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/badge/) - -Cordova Repo: [https://github.com/katzer/cordova-plugin-badge](https://github.com/katzer/cordova-plugin-badge) - - -The essential purpose of badge numbers is to enable an application to inform its users that it has something for them — for example, unread messages — when the application isn’t running in the foreground. - -Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge). - - -## Supported platforms - -- Android -- iOS -- Browser -- Windows -- Amazon FireOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/barcodescanner/readme.md b/src/@ionic-native/plugins/barcodescanner/readme.md deleted file mode 100644 index 4606ec86a..000000000 --- a/src/@ionic-native/plugins/barcodescanner/readme.md +++ /dev/null @@ -1,36 +0,0 @@ - - - Improve this doc - - -# Barcode Scanner - - -``` -$ npm install @ionic-native/barcodescanner --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/barcodescanner/) - -Cordova Repo: [https://github.com/phonegap/phonegap-plugin-barcodescanner](https://github.com/phonegap/phonegap-plugin-barcodescanner) - - -The Barcode Scanner Plugin opens a camera view and automatically scans a barcode, returning the data back to you. - -Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please see the [BarcodeScanner plugin docs](https://github.com/phonegap/phonegap-plugin-barcodescanner). - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 -- Windows 10 -- Windows 8 -- BlackBerry 10 -- Browser - - - - - diff --git a/src/@ionic-native/plugins/base64togallery/readme.md b/src/@ionic-native/plugins/base64togallery/readme.md deleted file mode 100644 index e9752ba10..000000000 --- a/src/@ionic-native/plugins/base64togallery/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# Base64 To Gallery - - -``` -$ npm install @ionic-native/base64togallery --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/base64togallery/) - -Cordova Repo: [https://github.com/Nexxa/cordova-base64-to-gallery](https://github.com/Nexxa/cordova-base64-to-gallery) - - -This plugin allows you to save base64 data as a png image into the device - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/batterystatus/readme.md b/src/@ionic-native/plugins/batterystatus/readme.md deleted file mode 100644 index 7f135cfc6..000000000 --- a/src/@ionic-native/plugins/batterystatus/readme.md +++ /dev/null @@ -1,36 +0,0 @@ - - - Improve this doc - - -# Battery Status - - -``` -$ npm install @ionic-native/batterystatus --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/batterystatus/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-battery-status](https://github.com/apache/cordova-plugin-battery-status) - - -Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status). - - -## Supported platforms - -- Amazon Fire OS -- iOS -- Android -- BlackBerry 10 -- Windows Phone 7 -- Windows Phone 8 -- Windows -- Firefox OS -- Browser - - - - - diff --git a/src/@ionic-native/plugins/ble/readme.md b/src/@ionic-native/plugins/ble/readme.md deleted file mode 100644 index c18fa67e4..000000000 --- a/src/@ionic-native/plugins/ble/readme.md +++ /dev/null @@ -1,41 +0,0 @@ - - - Improve this doc - - -# BLE - - -``` -$ npm install @ionic-native/ble --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/ble/) - -Cordova Repo: [https://github.com/don/cordova-plugin-ble-central](https://github.com/don/cordova-plugin-ble-central) - - -This plugin enables communication between a phone and Bluetooth Low Energy (BLE) peripherals. - -The plugin provides a simple JavaScript API for iOS and Android. - -- Scan for peripherals -- Connect to a peripheral -- Read the value of a characteristic -- Write new value to a characteristic -- Get notified when characteristic's value changes - -Advertising information is returned when scanning for peripherals. Service, characteristic, and property info is returned when connecting to a peripheral. All access is via service and characteristic UUIDs. The plugin manages handles internally. - -Simultaneous connections to multiple peripherals are supported. - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/bluetoothserial/readme.md b/src/@ionic-native/plugins/bluetoothserial/readme.md deleted file mode 100644 index 858187a95..000000000 --- a/src/@ionic-native/plugins/bluetoothserial/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# Bluetooth Serial - - -``` -$ npm install @ionic-native/bluetoothserial --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/bluetoothserial/) - -Cordova Repo: [https://github.com/don/BluetoothSerial](https://github.com/don/BluetoothSerial) - - -This plugin enables serial communication over Bluetooth. It was written for communicating between Android or iOS and an Arduino. - - -## Supported platforms - -- Android -- iOS -- Windows Phone -- Browser - - - - - diff --git a/src/@ionic-native/plugins/brightness/readme.md b/src/@ionic-native/plugins/brightness/readme.md deleted file mode 100644 index 8bc330f13..000000000 --- a/src/@ionic-native/plugins/brightness/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# Brightness - - -``` -$ npm install @ionic-native/brightness --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/brightness/) - -Cordova Repo: [https://github.com/mgcrea/cordova-plugin-brightness](https://github.com/mgcrea/cordova-plugin-brightness) - - -The Brightness plugin let you control the display brightness of your device. - -Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/broadcaster/readme.md b/src/@ionic-native/plugins/broadcaster/readme.md deleted file mode 100644 index f149b3425..000000000 --- a/src/@ionic-native/plugins/broadcaster/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# Broadcaster - - -``` -$ npm install @ionic-native/broadcaster --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/broadcaster/) - -Cordova Repo: [https://github.com/bsorrentino/cordova-broadcaster](https://github.com/bsorrentino/cordova-broadcaster) - - -This plugin adds exchanging events between native code and your app. - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/calendar/readme.md b/src/@ionic-native/plugins/calendar/readme.md deleted file mode 100644 index 1711e8e10..000000000 --- a/src/@ionic-native/plugins/calendar/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# Calendar - - -``` -$ npm install @ionic-native/calendar --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/calendar/) - -Cordova Repo: [https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin) - - -This plugin allows you to add events to the Calendar of the mobile device. - -Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see the [Calendar plugin docs](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/call-number/readme.md b/src/@ionic-native/plugins/call-number/readme.md deleted file mode 100644 index bca519829..000000000 --- a/src/@ionic-native/plugins/call-number/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# CallNumber - - -``` -$ npm install @ionic-native/call-number --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/call-number/) - -Cordova Repo: [https://github.com/Rohfosho/CordovaCallNumberPlugin](https://github.com/Rohfosho/CordovaCallNumberPlugin) - - -Call a number directly from your Cordova/Ionic application. - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/camera-preview/readme.md b/src/@ionic-native/plugins/camera-preview/readme.md deleted file mode 100644 index 51d9e8278..000000000 --- a/src/@ionic-native/plugins/camera-preview/readme.md +++ /dev/null @@ -1,37 +0,0 @@ - - - Improve this doc - - -# CameraPreview - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/camera-preview --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/camera-preview/) - -Cordova Repo: [https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview) - - -Showing camera preview in HTML - -For more info, please see the [Cordova Camera Preview Plugin Docs](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/camera/readme.md b/src/@ionic-native/plugins/camera/readme.md deleted file mode 100644 index 173883331..000000000 --- a/src/@ionic-native/plugins/camera/readme.md +++ /dev/null @@ -1,38 +0,0 @@ - - - Improve this doc - - -# Camera - - -``` -$ npm install @ionic-native/camera --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/camera/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-camera](https://github.com/apache/cordova-plugin-camera) - - -Take a photo or capture video. - -Requires ionic-native and the Cordova plugin: `cordova-plugin-camera`. For more info, please see the [Cordova Camera Plugin Docs](https://github.com/apache/cordova-plugin-camera). - - -## Supported platforms - -- Android -- BlackBerry -- Browser -- Firefox -- FireOS -- iOS -- Windows -- Windows Phone 8 -- Ubuntu - - - - - diff --git a/src/@ionic-native/plugins/card-io/readme.md b/src/@ionic-native/plugins/card-io/readme.md deleted file mode 100644 index bf17bbc9a..000000000 --- a/src/@ionic-native/plugins/card-io/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# CardIO - - -``` -$ npm install @ionic-native/card-io --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/card-io/) - -Cordova Repo: [https://github.com/card-io/card.io-Cordova-Plugin](https://github.com/card-io/card.io-Cordova-Plugin) - - - - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/clipboard/readme.md b/src/@ionic-native/plugins/clipboard/readme.md deleted file mode 100644 index cdc35c001..000000000 --- a/src/@ionic-native/plugins/clipboard/readme.md +++ /dev/null @@ -1,39 +0,0 @@ - - - Improve this doc - - -# Clipboard - - -``` -$ npm install @ionic-native/clipboard --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/clipboard/) - -Cordova Repo: [https://github.com/VersoSolutions/CordovaClipboard](https://github.com/VersoSolutions/CordovaClipboard) - - -Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8. - -Requires Cordova plugin: https://github.com/VersoSolutions/CordovaClipboard -For more info, please see the [Clipboard plugin docs](https://github.com/VersoSolutions/CordovaClipboard.git). - - -## Supported platforms - -- Amazon Fire OS -- iOS -- Android -- BlackBerry 10 -- Windows Phone 7 -- Windows Phone 8 -- Windows -- Firefox OS -- Browser - - - - - diff --git a/src/@ionic-native/plugins/code-push/readme.md b/src/@ionic-native/plugins/code-push/readme.md deleted file mode 100644 index 9e0bc16fa..000000000 --- a/src/@ionic-native/plugins/code-push/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# CodePush - - -``` -$ npm install @ionic-native/code-push --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/code-push/) - -Cordova Repo: [https://github.com/Microsoft/cordova-plugin-code-push](https://github.com/Microsoft/cordova-plugin-code-push) - - -CodePush plugin for Cordova by Microsoft that supports iOS and Android. - -For more info, please see https://github.com/ksachdeva/ionic2-code-push-example - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/contacts/readme.md b/src/@ionic-native/plugins/contacts/readme.md deleted file mode 100644 index 8607e6e60..000000000 --- a/src/@ionic-native/plugins/contacts/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Contacts - - -``` -$ npm install @ionic-native/contacts --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/contacts/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-contacts](https://github.com/apache/cordova-plugin-contacts) - - -Access and manage Contacts on the device. - - - diff --git a/src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html b/src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html deleted file mode 100644 index fea8137c2..000000000 --- a/src/@ionic-native/plugins/content/_includes/v2_fluid/native_menu.html +++ /dev/null @@ -1,366 +0,0 @@ - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/emailcomposer --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/emailcomposer/) - -Cordova Repo: [https://github.com/hypery2k/cordova-email-plugin](https://github.com/hypery2k/cordova-email-plugin) - - -Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the [Email Composer plugin docs](https://github.com/hypery2k/cordova-email-plugin). - -DISCLAIMER: This plugin is experiencing issues with the latest versions of Cordova. Use at your own risk. Functionality is not guaranteed. Please stay tuned for a more stable version. -A good alternative to this plugin is the social sharing plugin. - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/estimote-beacons/readme.md b/src/@ionic-native/plugins/estimote-beacons/readme.md deleted file mode 100644 index e2457b686..000000000 --- a/src/@ionic-native/plugins/estimote-beacons/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# EstimoteBeacons - - -``` -$ npm install @ionic-native/estimote-beacons --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/estimote-beacons/) - -Cordova Repo: [https://github.com/evothings/phonegap-estimotebeacons](https://github.com/evothings/phonegap-estimotebeacons) - - -This plugin enables communication between a phone and Estimote Beacons peripherals. - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/facebook/readme.md b/src/@ionic-native/plugins/facebook/readme.md deleted file mode 100644 index fd4e3fe35..000000000 --- a/src/@ionic-native/plugins/facebook/readme.md +++ /dev/null @@ -1,84 +0,0 @@ - - - Improve this doc - - -# Facebook - - -``` -$ ionic plugin add cordova-plugin-facebook4 --variable APP_ID="123456789" --variable APP_NAME="myApplication" -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/facebook/) - -Cordova Repo: [https://github.com/jeduan/cordova-plugin-facebook4](https://github.com/jeduan/cordova-plugin-facebook4) - - -Use the Facebook Connect plugin to obtain access to the native FB application on iOS and Android. - -Requires Cordova plugin: `cordova-plugin-facebook4`. For more info, please see the [Facebook Connect](https://github.com/jeduan/cordova-plugin-facebook4). - -#### Installation - - To use the FB plugin, you first have to create a new Facebook App inside of the Facebook developer portal at [https://developers.facebook.com/apps](https://developers.facebook.com/apps). - -[](https://developers.facebook.com/apps/) - -Retrieve the `App ID` and `App Name`. - -[](https://developers.facebook.com/apps/) - -Then type in the following command in your Terminal, where APP_ID and APP_NAME are the values from the Facebook Developer portal. - -```bash - ionic plugin add cordova-plugin-facebook4 --save --variable APP_ID="123456789" --variable APP_NAME="myApplication" -``` - -After, you'll need to add the native platforms you'll be using to your app in the Facebook Developer portal under your app's Settings: - -[](https://developers.facebook.com/apps/) - -Click `'Add Platform'`. - -[](https://developers.facebook.com/apps/) - -At this point you'll need to open your project's [`config.xml`](https://cordova.apache.org/docs/en/latest/config_ref/index.html) file, found in the root directory of your project. - -Take note of the `id` for the next step: -``` -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/fingerprint-aio --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/fingerprint-aio/) - -Cordova Repo: [https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio](https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio) - - -Use simple fingerprint authentication on Android and iOS. -Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plugin, vist: https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/firebase/readme.md b/src/@ionic-native/plugins/firebase/readme.md deleted file mode 100644 index b87a5ca11..000000000 --- a/src/@ionic-native/plugins/firebase/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# Firebase - - -``` -$ npm install @ionic-native/firebase --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/firebase/) - -Cordova Repo: [https://github.com/arnesson/cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) - - -This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/flashlight/readme.md b/src/@ionic-native/plugins/flashlight/readme.md deleted file mode 100644 index 1fabb91e1..000000000 --- a/src/@ionic-native/plugins/flashlight/readme.md +++ /dev/null @@ -1,23 +0,0 @@ - - - Improve this doc - - -# Flashlight - - -``` -$ npm install @ionic-native/flashlight --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/flashlight/) - -Cordova Repo: [https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin.git](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin.git) - - -This plugin allows you to switch the flashlight / torch of the device on and off. - -Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see the [Flashlight plugin docs](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin). - - - diff --git a/src/@ionic-native/plugins/geofence/readme.md b/src/@ionic-native/plugins/geofence/readme.md deleted file mode 100644 index 8b8efa6c5..000000000 --- a/src/@ionic-native/plugins/geofence/readme.md +++ /dev/null @@ -1,32 +0,0 @@ - - - Improve this doc - - -# Geofence - - -``` -$ npm install @ionic-native/geofence --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/geofence/) - -Cordova Repo: [https://github.com/cowbell/cordova-plugin-geofence/](https://github.com/cowbell/cordova-plugin-geofence/) - - -Monitors circular geofences around latitude/longitude coordinates, and sends a notification to the user when the boundary of a geofence is crossed. Notifications can be sent when the user enters and/or exits a geofence. -Geofences persist after device reboot. Geofences will be monitored even when the app is not running. - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 -- Windows Phone - - - - - diff --git a/src/@ionic-native/plugins/geolocation/readme.md b/src/@ionic-native/plugins/geolocation/readme.md deleted file mode 100644 index 0acdcfbc0..000000000 --- a/src/@ionic-native/plugins/geolocation/readme.md +++ /dev/null @@ -1,23 +0,0 @@ - - - Improve this doc - - -# Geolocation - - -``` -$ npm install @ionic-native/geolocation --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/geolocation/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-geolocation](https://github.com/apache/cordova-plugin-geolocation) - - -This plugin provides information about the device's location, such as latitude and longitude. Common sources of location information include Global Positioning System (GPS) and location inferred from network signals such as IP address, RFID, WiFi and Bluetooth MAC addresses, and GSM/CDMA cell IDs. - - This API is based on the W3C Geolocation API Specification, and only executes on devices that don't already provide an implementation. - - - diff --git a/src/@ionic-native/plugins/globalization/readme.md b/src/@ionic-native/plugins/globalization/readme.md deleted file mode 100644 index 5ecd9b218..000000000 --- a/src/@ionic-native/plugins/globalization/readme.md +++ /dev/null @@ -1,35 +0,0 @@ - - - Improve this doc - - -# Globalization - - -``` -$ npm install @ionic-native/globalization --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/globalization/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-globalization](https://github.com/apache/cordova-plugin-globalization) - - - - - -## Supported platforms - -- Amazon Fire OS -- Android -- BlackBerry 10 -- Firefox OS -- iOS -- Windows Phone 8 -- Widnows -- Browser - - - - - diff --git a/src/@ionic-native/plugins/google-plus/readme.md b/src/@ionic-native/plugins/google-plus/readme.md deleted file mode 100644 index 29626cce3..000000000 --- a/src/@ionic-native/plugins/google-plus/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# Google Plus - - -``` -$ ionic plugin add cordova-plugin-googleplus --variable REVERSED_CLIENT_ID=myreversedclientid -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/google-plus/) - -Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-googleplus](https://github.com/EddyVerbruggen/cordova-plugin-googleplus) - - - - - -## Supported platforms - -- Web -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/googleanalytics/readme.md b/src/@ionic-native/plugins/googleanalytics/readme.md deleted file mode 100644 index fa154364f..000000000 --- a/src/@ionic-native/plugins/googleanalytics/readme.md +++ /dev/null @@ -1,34 +0,0 @@ - - - Improve this doc - - -# Google Analytics - - -``` -$ npm install @ionic-native/googleanalytics --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/googleanalytics/) - -Cordova Repo: [https://github.com/danwilson/google-analytics-plugin](https://github.com/danwilson/google-analytics-plugin) - - -This plugin connects to Google's native Universal Analytics SDK -Prerequisites: -- A Cordova 3.0+ project for iOS and/or Android -- A Mobile App property through the Google Analytics Admin Console -- (Android) Google Play Services SDK installed via [Android SDK Manager](https://developer.android.com/sdk/installing/adding-packages.html) - - -## Supported platforms - -- Android -- iOS -- Browser - - - - - diff --git a/src/@ionic-native/plugins/googlemap/readme.md b/src/@ionic-native/plugins/googlemap/readme.md deleted file mode 100644 index 89f83ffa5..000000000 --- a/src/@ionic-native/plugins/googlemap/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Google Maps - - -``` -$ ionic plugin add cordova-plugin-googlemaps --variable API_KEY_FOR_ANDROID="YOUR_ANDROID_API_KEY_IS_HERE" --variable API_KEY_FOR_IOS="YOUR_IOS_API_KEY_IS_HERE" -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/googlemap/) - -Cordova Repo: [https://github.com/mapsplugin/cordova-plugin-googlemaps](https://github.com/mapsplugin/cordova-plugin-googlemaps) - - -This plugin uses the native Google Maps SDK - - - diff --git a/src/@ionic-native/plugins/headercolor/readme.md b/src/@ionic-native/plugins/headercolor/readme.md deleted file mode 100644 index c4e3e19ce..000000000 --- a/src/@ionic-native/plugins/headercolor/readme.md +++ /dev/null @@ -1,28 +0,0 @@ - - - Improve this doc - - -# HeaderColor - - -``` -$ npm install @ionic-native/headercolor --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/headercolor/) - -Cordova Repo: [https://github.com/tomloprod/cordova-plugin-headercolor](https://github.com/tomloprod/cordova-plugin-headercolor) - - -Cordova plugin to change color of header in multitask view - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/hotspot/readme.md b/src/@ionic-native/plugins/hotspot/readme.md deleted file mode 100644 index 414714f02..000000000 --- a/src/@ionic-native/plugins/hotspot/readme.md +++ /dev/null @@ -1,34 +0,0 @@ - - - Improve this doc - - -# Hotspot - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/hotspot --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/hotspot/) - -Cordova Repo: [https://github.com/hypery2k/cordova-hotspot-plugin](https://github.com/hypery2k/cordova-hotspot-plugin) - - - - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/http/readme.md b/src/@ionic-native/plugins/http/readme.md deleted file mode 100644 index dc26fcbec..000000000 --- a/src/@ionic-native/plugins/http/readme.md +++ /dev/null @@ -1,33 +0,0 @@ - - - Improve this doc - - -# HTTP - - -``` -$ npm install @ionic-native/http --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/http/) - -Cordova Repo: [https://github.com/wymsee/cordova-HTTP](https://github.com/wymsee/cordova-HTTP) - - -Cordova / Phonegap plugin for communicating with HTTP servers. Supports iOS and Android. - -Advantages over Javascript requests: -- Background threading - all requests are done in a background thread -- SSL Pinning - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/httpd/readme.md b/src/@ionic-native/plugins/httpd/readme.md deleted file mode 100644 index 9f4d452d5..000000000 --- a/src/@ionic-native/plugins/httpd/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# Httpd - - -``` -$ npm install @ionic-native/httpd --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/httpd/) - -Cordova Repo: [https://github.com/floatinghotpot/cordova-httpd](https://github.com/floatinghotpot/cordova-httpd) - - -Embedded httpd for Cordova apps. Light weight HTTP server. - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/ibeacon/readme.md b/src/@ionic-native/plugins/ibeacon/readme.md deleted file mode 100644 index 46d20d906..000000000 --- a/src/@ionic-native/plugins/ibeacon/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# IBeacon - - -``` -$ npm install @ionic-native/ibeacon --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/ibeacon/) - -Cordova Repo: [https://github.com/petermetz/cordova-plugin-ibeacon](https://github.com/petermetz/cordova-plugin-ibeacon) - - -This plugin provides functions for working with iBeacons. - - The plugin's API closely mimics the one exposed through the [CLLocationManager](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html) introduced in iOS 7. - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/imagepicker/readme.md b/src/@ionic-native/plugins/imagepicker/readme.md deleted file mode 100644 index 0444f2115..000000000 --- a/src/@ionic-native/plugins/imagepicker/readme.md +++ /dev/null @@ -1,24 +0,0 @@ - - - Improve this doc - - -# Image Picker - - -``` -$ npm install @ionic-native/imagepicker --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/imagepicker/) - -Cordova Repo: [https://github.com/Telerik-Verified-Plugins/ImagePicker](https://github.com/Telerik-Verified-Plugins/ImagePicker) - - -Cordova Plugin For Multiple Image Selection - -Requires Cordova plugin: `cordova-plugin-image-picker`. -For more info, please see the https://github.com/wymsee/cordova-imagePicker - - - diff --git a/src/@ionic-native/plugins/imageresizer/readme.md b/src/@ionic-native/plugins/imageresizer/readme.md deleted file mode 100644 index 801bbd11e..000000000 --- a/src/@ionic-native/plugins/imageresizer/readme.md +++ /dev/null @@ -1,26 +0,0 @@ - - - Improve this doc - - -# ImageResizer - - -``` -$ npm install @ionic-native/imageresizer --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/imageresizer/) - -Cordova Repo: [https://github.com/protonet/cordova-plugin-image-resizer](https://github.com/protonet/cordova-plugin-image-resizer) - - -Cordova Plugin For Image Resize - -Requires plugin `info.protonet.imageresizer` - use the Ionic CLI and type in the following command: -`ionic plugin add https://github.com/protonet/cordova-plugin-image-resizer.git` - -For more info, please see the https://github.com/protonet/cordova-plugin-image-resizer - - - diff --git a/src/@ionic-native/plugins/inappbrowser/readme.md b/src/@ionic-native/plugins/inappbrowser/readme.md deleted file mode 100644 index dab8783ea..000000000 --- a/src/@ionic-native/plugins/inappbrowser/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# InAppBrowser - - -``` -$ npm install @ionic-native/inappbrowser --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/inappbrowser/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-inappbrowser](https://github.com/apache/cordova-plugin-inappbrowser) - - -Launches in app Browser - - - diff --git a/src/@ionic-native/plugins/inapppurchase/readme.md b/src/@ionic-native/plugins/inapppurchase/readme.md deleted file mode 100644 index c8dc3d3e9..000000000 --- a/src/@ionic-native/plugins/inapppurchase/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# InAppPurchase - - -``` -$ npm install @ionic-native/inapppurchase --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/inapppurchase/) - -Cordova Repo: [https://github.com/AlexDisler/cordova-plugin-inapppurchase](https://github.com/AlexDisler/cordova-plugin-inapppurchase) - - -A lightweight Cordova plugin for in app purchases on iOS/Android. - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/insomnia/readme.md b/src/@ionic-native/plugins/insomnia/readme.md deleted file mode 100644 index 1e6e5e703..000000000 --- a/src/@ionic-native/plugins/insomnia/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# Insomnia - - -``` -$ npm install @ionic-native/insomnia --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/insomnia/) - -Cordova Repo: [https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Insomnia-PhoneGap-Plugin) - - -Prevent the screen of the mobile device from falling asleep. - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/instagram/readme.md b/src/@ionic-native/plugins/instagram/readme.md deleted file mode 100644 index a5eb03a53..000000000 --- a/src/@ionic-native/plugins/instagram/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Instagram - - -``` -$ npm install @ionic-native/instagram --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/instagram/) - -Cordova Repo: [https://github.com/vstirbu/InstagramPlugin](https://github.com/vstirbu/InstagramPlugin) - - -Share a photo with the instagram app - - - diff --git a/src/@ionic-native/plugins/is-debug/readme.md b/src/@ionic-native/plugins/is-debug/readme.md deleted file mode 100644 index 6195ee61d..000000000 --- a/src/@ionic-native/plugins/is-debug/readme.md +++ /dev/null @@ -1,22 +0,0 @@ - - - Improve this doc - - -# IsDebug - - -``` -$ npm install @ionic-native/is-debug --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/is-debug/) - -Cordova Repo: [https://github.com/mattlewis92/cordova-plugin-is-debug](https://github.com/mattlewis92/cordova-plugin-is-debug) - - -Detect if the app is running in debug mode or not. -Debug mode is when the app is built and installed locally via xcode / eclipse / the cordova cli etc, compared to release mode when the app was downloaded from the app / play store via an end user. - - - diff --git a/src/@ionic-native/plugins/keyboard/readme.md b/src/@ionic-native/plugins/keyboard/readme.md deleted file mode 100644 index a4ebb1b59..000000000 --- a/src/@ionic-native/plugins/keyboard/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Keyboard - - -``` -$ npm install @ionic-native/keyboard --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/keyboard/) - -Cordova Repo: [https://github.com/driftyco/ionic-plugin-keyboard](https://github.com/driftyco/ionic-plugin-keyboard) - - - - - - diff --git a/src/@ionic-native/plugins/launch-review/readme.md b/src/@ionic-native/plugins/launch-review/readme.md deleted file mode 100644 index 44a34a75b..000000000 --- a/src/@ionic-native/plugins/launch-review/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# LaunchReview - - -``` -$ npm install @ionic-native/launch-review --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/launch-review/) - -Cordova Repo: [https://github.com/dpa99c/cordova-launch-review](https://github.com/dpa99c/cordova-launch-review) - - -This launches the native store app in order for the user to leave a review. -On Android, the plugin opens the the app's storepage in the Play Store where the user can leave a review by pressing the stars to give a rating. -On iOS, the plugin opens the app's storepage in the App Store and focuses the Review tab, where the user can leave a review by pressing "Write a review". - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/launchnavigator/readme.md b/src/@ionic-native/plugins/launchnavigator/readme.md deleted file mode 100644 index b5d7e727f..000000000 --- a/src/@ionic-native/plugins/launchnavigator/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Launch Navigator - - -``` -$ npm install @ionic-native/launchnavigator --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/launchnavigator/) - -Cordova Repo: [https://github.com/dpa99c/phonegap-launch-navigator.git](https://github.com/dpa99c/phonegap-launch-navigator.git) - - -Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For more info, please see the [LaunchNavigator plugin docs](https://github.com/dpa99c/phonegap-launch-navigator). - - - diff --git a/src/@ionic-native/plugins/localnotifications/readme.md b/src/@ionic-native/plugins/localnotifications/readme.md deleted file mode 100644 index d8a2f9d21..000000000 --- a/src/@ionic-native/plugins/localnotifications/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Local Notifications - - -``` -$ npm install @ionic-native/localnotifications --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/localnotifications/) - -Cordova Repo: [https://github.com/katzer/cordova-plugin-local-notifications](https://github.com/katzer/cordova-plugin-local-notifications) - - -This plugin allows you to display local notifications on the device - - - diff --git a/src/@ionic-native/plugins/location-accuracy/readme.md b/src/@ionic-native/plugins/location-accuracy/readme.md deleted file mode 100644 index f33e33dc2..000000000 --- a/src/@ionic-native/plugins/location-accuracy/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# LocationAccuracy - - -``` -$ npm install @ionic-native/location-accuracy --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/location-accuracy/) - -Cordova Repo: [https://github.com/dpa99c/cordova-plugin-request-location-accuracy](https://github.com/dpa99c/cordova-plugin-request-location-accuracy) - - -This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually. - - - diff --git a/src/@ionic-native/plugins/market/readme.md b/src/@ionic-native/plugins/market/readme.md deleted file mode 100644 index 2f9011d9e..000000000 --- a/src/@ionic-native/plugins/market/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Market - - -``` -$ npm install @ionic-native/market --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/market/) - -Cordova Repo: [https://github.com/xmartlabs/cordova-plugin-market](https://github.com/xmartlabs/cordova-plugin-market) - - -Opens an app's page in the market place (Google Play, App Store) - - - diff --git a/src/@ionic-native/plugins/media-capture/readme.md b/src/@ionic-native/plugins/media-capture/readme.md deleted file mode 100644 index 1fd99c4bc..000000000 --- a/src/@ionic-native/plugins/media-capture/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Media Capture - - -``` -$ npm install @ionic-native/media-capture --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/media-capture/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-media-capture](https://github.com/apache/cordova-plugin-media-capture) - - - - - - diff --git a/src/@ionic-native/plugins/media/readme.md b/src/@ionic-native/plugins/media/readme.md deleted file mode 100644 index d6b1466d6..000000000 --- a/src/@ionic-native/plugins/media/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# MediaPlugin - - -``` -$ npm install @ionic-native/media --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/media/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-media](https://github.com/apache/cordova-plugin-media) - - - - - - diff --git a/src/@ionic-native/plugins/mixpanel/readme.md b/src/@ionic-native/plugins/mixpanel/readme.md deleted file mode 100644 index e45ecdf9a..000000000 --- a/src/@ionic-native/plugins/mixpanel/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Mixpanel - - -``` -$ npm install @ionic-native/mixpanel --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/mixpanel/) - -Cordova Repo: [https://github.com/samzilverberg/cordova-mixpanel-plugin](https://github.com/samzilverberg/cordova-mixpanel-plugin) - - -Cordova Plugin that wraps Mixpanel SDK for Android and iOS - - - diff --git a/src/@ionic-native/plugins/music-controls/readme.md b/src/@ionic-native/plugins/music-controls/readme.md deleted file mode 100644 index 84cbb5606..000000000 --- a/src/@ionic-native/plugins/music-controls/readme.md +++ /dev/null @@ -1,23 +0,0 @@ - - - Improve this doc - - -# MusicControls - - -``` -$ npm install @ionic-native/music-controls --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/music-controls/) - -Cordova Repo: [https://github.com/homerours/cordova-music-controls-plugin](https://github.com/homerours/cordova-music-controls-plugin) - - -Music controls for Cordova applications. -Display a 'media' notification with play/pause, previous, next buttons, allowing the user to control the play. -Handle also headset event (plug, unplug, headset button). - - - diff --git a/src/@ionic-native/plugins/native-audio/readme.md b/src/@ionic-native/plugins/native-audio/readme.md deleted file mode 100644 index 69f7d9ebe..000000000 --- a/src/@ionic-native/plugins/native-audio/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# NativeAudio - - -``` -$ npm install @ionic-native/native-audio --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/native-audio/) - -Cordova Repo: [https://github.com/floatinghotpot/cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio) - - -Native Audio Playback - - - diff --git a/src/@ionic-native/plugins/native-geocoder/readme.md b/src/@ionic-native/plugins/native-geocoder/readme.md deleted file mode 100644 index 6f5af3dee..000000000 --- a/src/@ionic-native/plugins/native-geocoder/readme.md +++ /dev/null @@ -1,35 +0,0 @@ - - - Improve this doc - - -# NativeGeocoder - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/native-geocoder --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/native-geocoder/) - -Cordova Repo: [https://github.com/sebastianbaar/cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) - - -Cordova plugin for native forward and reverse geocoding - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/native-page-transitions/readme.md b/src/@ionic-native/plugins/native-page-transitions/readme.md deleted file mode 100644 index d27abbc1e..000000000 --- a/src/@ionic-native/plugins/native-page-transitions/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# NativePageTransitions - - -``` -$ npm install @ionic-native/native-page-transitions --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/native-page-transitions/) - -Cordova Repo: [https://github.com/Telerik-Verified-Plugins/NativePageTransitions](https://github.com/Telerik-Verified-Plugins/NativePageTransitions) - - -The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction. - - -## Supported platforms - -- iOS -- Android -- Windows Phone - - - - - diff --git a/src/@ionic-native/plugins/nativestorage/readme.md b/src/@ionic-native/plugins/nativestorage/readme.md deleted file mode 100644 index 27f838eeb..000000000 --- a/src/@ionic-native/plugins/nativestorage/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# NativeStorage - - -``` -$ npm install @ionic-native/nativestorage --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/nativestorage/) - -Cordova Repo: [https://github.com/TheCocoaProject/cordova-plugin-nativestorage](https://github.com/TheCocoaProject/cordova-plugin-nativestorage) - - -Native storage of variables in Android and iOS - - - diff --git a/src/@ionic-native/plugins/navigationbar/readme.md b/src/@ionic-native/plugins/navigationbar/readme.md deleted file mode 100644 index e03384115..000000000 --- a/src/@ionic-native/plugins/navigationbar/readme.md +++ /dev/null @@ -1,34 +0,0 @@ - - - Improve this doc - - -# NavigationBar - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/navigationbar --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/navigationbar/) - -Cordova Repo: [https://github.com/cranberrygame/cordova-plugin-navigationbar](https://github.com/cranberrygame/cordova-plugin-navigationbar) - - -The NavigationBar plugin can you to hide and auto hide the android navigation bar. - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/network/readme.md b/src/@ionic-native/plugins/network/readme.md deleted file mode 100644 index fe2f0f73f..000000000 --- a/src/@ionic-native/plugins/network/readme.md +++ /dev/null @@ -1,36 +0,0 @@ - - - Improve this doc - - -# Network - - -``` -$ npm install @ionic-native/network --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/network/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-network-information](https://github.com/apache/cordova-plugin-network-information) - - -Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin docs](https://github.com/apache/cordova-plugin-network-information). - - -## Supported platforms - -- Amazon Fire OS -- iOS -- Android -- BlackBerry 10 -- Windows Phone 7 -- Windows Phone 8 -- Windows -- Firefox OS -- Browser - - - - - diff --git a/src/@ionic-native/plugins/nfc/readme.md b/src/@ionic-native/plugins/nfc/readme.md deleted file mode 100644 index 8c4179ecd..000000000 --- a/src/@ionic-native/plugins/nfc/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# NFC - - -``` -$ npm install @ionic-native/nfc --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/nfc/) - -Cordova Repo: [https://github.com/chariotsolutions/phonegap-nfc](https://github.com/chariotsolutions/phonegap-nfc) - - -The NFC plugin allows you to read and write NFC tags. You can also beam to, and receive from, other NFC enabled devices. - -Use to -- read data from NFC tags -- write data to NFC tags -- send data to other NFC enabled devices -- receive data from NFC devices - -This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems. - - - diff --git a/src/@ionic-native/plugins/onesignal/readme.md b/src/@ionic-native/plugins/onesignal/readme.md deleted file mode 100644 index e0a872798..000000000 --- a/src/@ionic-native/plugins/onesignal/readme.md +++ /dev/null @@ -1,34 +0,0 @@ - - - Improve this doc - - -# OneSignal - - -``` -$ npm install @ionic-native/onesignal --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/onesignal/) - -Cordova Repo: [https://github.com/OneSignal/OneSignal-Cordova-SDK](https://github.com/OneSignal/OneSignal-Cordova-SDK) - - -The OneSignal plugin is an client implementation for using the [OneSignal](https://onesignal.com/) Service. -OneSignal is a simple implementation for delivering push notifications. - -Requires Cordova plugin: `onesignal-cordova-plugin`. For more info, please see the [OneSignal Cordova Docs](https://documentation.onesignal.com/docs/phonegap-sdk-installation). - - -## Supported platforms - -- Android -- iOS -- Windows -- FireOS - - - - - diff --git a/src/@ionic-native/plugins/pay-pal/readme.md b/src/@ionic-native/plugins/pay-pal/readme.md deleted file mode 100644 index 1e11d2532..000000000 --- a/src/@ionic-native/plugins/pay-pal/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# PayPal - - -``` -$ npm install @ionic-native/pay-pal --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/pay-pal/) - -Cordova Repo: [https://github.com/paypal/PayPal-Cordova-Plugin](https://github.com/paypal/PayPal-Cordova-Plugin) - - -PayPal plugin for Cordova/Ionic Applications - - - diff --git a/src/@ionic-native/plugins/photo-viewer/readme.md b/src/@ionic-native/plugins/photo-viewer/readme.md deleted file mode 100644 index 5f2209a2c..000000000 --- a/src/@ionic-native/plugins/photo-viewer/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Photo Viewer - - -``` -$ npm install @ionic-native/photo-viewer --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/photo-viewer/) - -Cordova Repo: [https://github.com/sarriaroman/photoviewer](https://github.com/sarriaroman/photoviewer) - - -This plugin can display your image in full screen with the ability to pan, zoom, and share the image. - - - diff --git a/src/@ionic-native/plugins/pin-dialog/readme.md b/src/@ionic-native/plugins/pin-dialog/readme.md deleted file mode 100644 index 54ca16efb..000000000 --- a/src/@ionic-native/plugins/pin-dialog/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Pin Dialog - - -``` -$ npm install @ionic-native/pin-dialog --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/pin-dialog/) - -Cordova Repo: [https://github.com/Paldom/PinDialog](https://github.com/Paldom/PinDialog) - - - - - - diff --git a/src/@ionic-native/plugins/pinterest/readme.md b/src/@ionic-native/plugins/pinterest/readme.md deleted file mode 100644 index 9e3b292af..000000000 --- a/src/@ionic-native/plugins/pinterest/readme.md +++ /dev/null @@ -1,35 +0,0 @@ - - - Improve this doc - - -# Pinterest - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ ionic plugin add cordova-plugin-pinterest --variable APP_ID=YOUR_APP_ID -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/pinterest/) - -Cordova Repo: [https://github.com/zyramedia/cordova-plugin-pinterest](https://github.com/zyramedia/cordova-plugin-pinterest) - - -Cordova plugin for Pinterest - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/power-management/readme.md b/src/@ionic-native/plugins/power-management/readme.md deleted file mode 100644 index 3c2d90ba1..000000000 --- a/src/@ionic-native/plugins/power-management/readme.md +++ /dev/null @@ -1,22 +0,0 @@ - - - Improve this doc - - -# PowerManagement - - -``` -$ npm install @ionic-native/power-management --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/power-management/) - -Cordova Repo: [https://github.com/Viras-/cordova-plugin-powermanagement](https://github.com/Viras-/cordova-plugin-powermanagement) - - -The PowerManagement plugin offers access to the devices power-management functionality. -It should be used for applications which keep running for a long time without any user interaction. - - - diff --git a/src/@ionic-native/plugins/printer/readme.md b/src/@ionic-native/plugins/printer/readme.md deleted file mode 100644 index 18d37fba6..000000000 --- a/src/@ionic-native/plugins/printer/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# Printer - - -``` -$ npm install @ionic-native/printer --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/printer/) - -Cordova Repo: [https://github.com/katzer/cordova-plugin-printer.git](https://github.com/katzer/cordova-plugin-printer.git) - - -Prints documents or HTML rendered content - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/push/readme.md b/src/@ionic-native/plugins/push/readme.md deleted file mode 100644 index ad1aad6fb..000000000 --- a/src/@ionic-native/plugins/push/readme.md +++ /dev/null @@ -1,25 +0,0 @@ - - - Improve this doc - - -# Push - - -``` -$ ionic plugin add phonegap-plugin-push --variable SENDER_ID=XXXXXXXXX -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/push/) - -Cordova Repo: [https://github.com/phonegap/phonegap-plugin-push](https://github.com/phonegap/phonegap-plugin-push) - - -Register and receive push notifications. - -Requires Cordova plugin: `phonegap-plugin-push`. For more info, please see the [Push plugin docs](https://github.com/phonegap/phonegap-plugin-push). - -For TypeScript users, see the [Push plugin docs about using TypeScript for custom notifications](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/TYPESCRIPT.md). - - - diff --git a/src/@ionic-native/plugins/rollbar/readme.md b/src/@ionic-native/plugins/rollbar/readme.md deleted file mode 100644 index 451f4b227..000000000 --- a/src/@ionic-native/plugins/rollbar/readme.md +++ /dev/null @@ -1,35 +0,0 @@ - - - Improve this doc - - -# Rollbar - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ ionic plugin add resgrid-cordova-plugins-rollbar --variable ROLLBAR_ACCESS_TOKEN="YOUR_ROLLBAR_ACCEESS_TOKEN" --variable ROLLBAR_ENVIRONMENT="ROLLBAR_ENVIRONMENT" -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/rollbar/) - -Cordova Repo: [https://github.com/Resgrid/cordova-plugins-rollbar](https://github.com/Resgrid/cordova-plugins-rollbar) - - -This plugin adds Rollbar App monitoring to your application - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/safari-view-controller/readme.md b/src/@ionic-native/plugins/safari-view-controller/readme.md deleted file mode 100644 index 19b98ae6d..000000000 --- a/src/@ionic-native/plugins/safari-view-controller/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# SafariViewController - - -``` -$ npm install @ionic-native/safari-view-controller --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/safari-view-controller/) - -Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller](https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller) - - - - - -## Supported platforms - -- iOS -- Android - - - - - diff --git a/src/@ionic-native/plugins/screen-orientation/readme.md b/src/@ionic-native/plugins/screen-orientation/readme.md deleted file mode 100644 index 480f3e719..000000000 --- a/src/@ionic-native/plugins/screen-orientation/readme.md +++ /dev/null @@ -1,33 +0,0 @@ - - - Improve this doc - - -# Screen Orientation - - -``` -$ npm install @ionic-native/screen-orientation --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/screen-orientation/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-screen-orientation](https://github.com/apache/cordova-plugin-screen-orientation) - - -Cordova plugin to set/lock the screen orientation in a common way for iOS, Android, WP8 and Blackberry 10. -This plugin is based on an early version of Screen Orientation API so the api does not currently match the current spec. - -Requires Cordova plugin: `cordova-plugin-screen-orientation`. For more info, please see the [Screen Orientation plugin docs](https://github.com/apache/cordova-plugin-screen-orientation). - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/screenshot/readme.md b/src/@ionic-native/plugins/screenshot/readme.md deleted file mode 100644 index e2ca29fe5..000000000 --- a/src/@ionic-native/plugins/screenshot/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Screenshot - - -``` -$ npm install @ionic-native/screenshot --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/screenshot/) - -Cordova Repo: [https://github.com/gitawego/cordova-screenshot.git](https://github.com/gitawego/cordova-screenshot.git) - - -Captures a screen shot - - - diff --git a/src/@ionic-native/plugins/securestorage/readme.md b/src/@ionic-native/plugins/securestorage/readme.md deleted file mode 100644 index 82f306fd0..000000000 --- a/src/@ionic-native/plugins/securestorage/readme.md +++ /dev/null @@ -1,33 +0,0 @@ - - - Improve this doc - - -# Secure Storage - - -``` -$ npm install @ionic-native/securestorage --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/securestorage/) - -Cordova Repo: [https://github.com/Crypho/cordova-plugin-secure-storage](https://github.com/Crypho/cordova-plugin-secure-storage) - - -This plugin gets, sets and removes key,value pairs from a device's secure storage. - -Requires Cordova plugin: `cordova-plugin-secure-storage`. For more info, please see the [Cordova Secure Storage docs](https://github.com/Crypho/cordova-plugin-secure-storage). - - -## Supported platforms - -- Android -- iOS -- Windows Phone -- Browser - - - - - diff --git a/src/@ionic-native/plugins/serial/readme.md b/src/@ionic-native/plugins/serial/readme.md deleted file mode 100644 index 991964474..000000000 --- a/src/@ionic-native/plugins/serial/readme.md +++ /dev/null @@ -1,28 +0,0 @@ - - - Improve this doc - - -# Serial - - -``` -$ npm install @ionic-native/serial --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/serial/) - -Cordova Repo: [https://github.com/xseignard/cordovarduino](https://github.com/xseignard/cordovarduino) - - -This plugin provides functions for working with Serial connections - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/shake/readme.md b/src/@ionic-native/plugins/shake/readme.md deleted file mode 100644 index 2f718f270..000000000 --- a/src/@ionic-native/plugins/shake/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Shake - - -``` -$ npm install @ionic-native/shake --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/shake/) - -Cordova Repo: [https://github.com/leecrossley/cordova-plugin-shake](https://github.com/leecrossley/cordova-plugin-shake) - - -Handles shake gesture - - - diff --git a/src/@ionic-native/plugins/sim/readme.md b/src/@ionic-native/plugins/sim/readme.md deleted file mode 100644 index 29146effb..000000000 --- a/src/@ionic-native/plugins/sim/readme.md +++ /dev/null @@ -1,32 +0,0 @@ - - - Improve this doc - - -# Sim - - -``` -$ npm install @ionic-native/sim --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/sim/) - -Cordova Repo: [https://github.com/pbakondy/cordova-plugin-sim](https://github.com/pbakondy/cordova-plugin-sim) - - -Gets info from the Sim card like the carrier name, mcc, mnc and country code and other system dependent info. - -Requires Cordova plugin: `cordova-plugin-sim`. For more info, please see the [Cordova Sim docs](https://github.com/pbakondy/cordova-plugin-sim). - - -## Supported platforms - -- Android -- iOS -- Windows Phone - - - - - diff --git a/src/@ionic-native/plugins/sms/readme.md b/src/@ionic-native/plugins/sms/readme.md deleted file mode 100644 index 47435c967..000000000 --- a/src/@ionic-native/plugins/sms/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# SMS - - -``` -$ npm install @ionic-native/sms --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/sms/) - -Cordova Repo: [https://github.com/cordova-sms/cordova-sms-plugin](https://github.com/cordova-sms/cordova-sms-plugin) - - -Requires Cordova plugin: cordova-plugin-sms. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin). - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/socialsharing/readme.md b/src/@ionic-native/plugins/socialsharing/readme.md deleted file mode 100644 index c42579c1c..000000000 --- a/src/@ionic-native/plugins/socialsharing/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# Social Sharing - - -``` -$ npm install @ionic-native/socialsharing --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/socialsharing/) - -Cordova Repo: [https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin](https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin) - - -Share text, files, images, and links via social networks, sms, and email. - - -## Supported platforms - -- iOS -- Android -- Windows Phone - - - - - diff --git a/src/@ionic-native/plugins/speech-recognition/readme.md b/src/@ionic-native/plugins/speech-recognition/readme.md deleted file mode 100644 index 327712d56..000000000 --- a/src/@ionic-native/plugins/speech-recognition/readme.md +++ /dev/null @@ -1,35 +0,0 @@ - - - Improve this doc - - -# SpeechRecognition - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/speech-recognition --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/speech-recognition/) - -Cordova Repo: [https://github.com/pbakondy/cordova-plugin-speechrecognition](https://github.com/pbakondy/cordova-plugin-speechrecognition) - - -This plugin does speech recognition using cloud services - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/spinnerdialog/readme.md b/src/@ionic-native/plugins/spinnerdialog/readme.md deleted file mode 100644 index 74baa43d8..000000000 --- a/src/@ionic-native/plugins/spinnerdialog/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# Spinner Dialog - - -``` -$ npm install @ionic-native/spinnerdialog --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/spinnerdialog/) - -Cordova Repo: [https://github.com/Paldom/SpinnerDialog](https://github.com/Paldom/SpinnerDialog) - - - - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/splashscreen/readme.md b/src/@ionic-native/plugins/splashscreen/readme.md deleted file mode 100644 index 177713f81..000000000 --- a/src/@ionic-native/plugins/splashscreen/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Splashscreen - - -``` -$ npm install @ionic-native/splashscreen --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/splashscreen/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-splashscreen](https://github.com/apache/cordova-plugin-splashscreen) - - -This plugin displays and hides a splash screen during application launch. The methods below allows showing and hiding the splashscreen after the app has loaded. - - - diff --git a/src/@ionic-native/plugins/sqlite/readme.md b/src/@ionic-native/plugins/sqlite/readme.md deleted file mode 100644 index 5f9213cb1..000000000 --- a/src/@ionic-native/plugins/sqlite/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# SQLite - - -``` -$ npm install @ionic-native/sqlite --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/sqlite/) - -Cordova Repo: [https://github.com/litehelpers/Cordova-sqlite-storage](https://github.com/litehelpers/Cordova-sqlite-storage) - - -Access SQLite databases on the device. - - - diff --git a/src/@ionic-native/plugins/statusbar/readme.md b/src/@ionic-native/plugins/statusbar/readme.md deleted file mode 100644 index 94ba02402..000000000 --- a/src/@ionic-native/plugins/statusbar/readme.md +++ /dev/null @@ -1,34 +0,0 @@ - - - Improve this doc - - -# Status Bar - - -``` -$ npm install @ionic-native/statusbar --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/statusbar/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-statusbar](https://github.com/apache/cordova-plugin-statusbar) - - -Manage the appearance of the native status bar. - -Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar). - - -## Supported platforms - -- iOS -- Android -- Windows Phone 8 -- Windows 8 -- Windows 10 - - - - - diff --git a/src/@ionic-native/plugins/stepcounter/readme.md b/src/@ionic-native/plugins/stepcounter/readme.md deleted file mode 100644 index 798f3bdef..000000000 --- a/src/@ionic-native/plugins/stepcounter/readme.md +++ /dev/null @@ -1,32 +0,0 @@ - - - Improve this doc - - -# Stepcounter - - -``` -$ npm install @ionic-native/stepcounter --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/stepcounter/) - -Cordova Repo: [https://github.com/Slidee/cordova-plugin-stepcounter](https://github.com/Slidee/cordova-plugin-stepcounter) - - -Cordova plugin for using device's stepcounter on Android (API > 19) - -Use to -- start and stop stepcounter service -- read device's stepcounter data - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/streaming-media/readme.md b/src/@ionic-native/plugins/streaming-media/readme.md deleted file mode 100644 index 4980281a2..000000000 --- a/src/@ionic-native/plugins/streaming-media/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# StreamingMedia - - -``` -$ npm install @ionic-native/streaming-media --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/streaming-media/) - -Cordova Repo: [https://github.com/nchutchind/cordova-plugin-streaming-media](https://github.com/nchutchind/cordova-plugin-streaming-media) - - -This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android. - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/stripe/readme.md b/src/@ionic-native/plugins/stripe/readme.md deleted file mode 100644 index 6125eee0c..000000000 --- a/src/@ionic-native/plugins/stripe/readme.md +++ /dev/null @@ -1,27 +0,0 @@ - - - Improve this doc - - -# Stripe - - -- This plugin is still in beta stage and may not work as expected. Please - submit any issues to the plugin repo. -
- -``` -$ npm install @ionic-native/stripe --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/stripe/) - -Cordova Repo: [https://github.com/zyramedia/cordova-plugin-stripe](https://github.com/zyramedia/cordova-plugin-stripe) - - -A plugin that allows you to use Stripe's Native SDKs for Android and iOS. - - - diff --git a/src/@ionic-native/plugins/text-to-speech/readme.md b/src/@ionic-native/plugins/text-to-speech/readme.md deleted file mode 100644 index ae9d853b0..000000000 --- a/src/@ionic-native/plugins/text-to-speech/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# TextToSpeech - - -``` -$ npm install @ionic-native/text-to-speech --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/text-to-speech/) - -Cordova Repo: [https://github.com/vilic/cordova-plugin-tts](https://github.com/vilic/cordova-plugin-tts) - - -Text to Speech plugin - - - diff --git a/src/@ionic-native/plugins/themeable-browser/readme.md b/src/@ionic-native/plugins/themeable-browser/readme.md deleted file mode 100644 index 915c1d148..000000000 --- a/src/@ionic-native/plugins/themeable-browser/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# ThemeableBrowser - - -``` -$ npm install @ionic-native/themeable-browser --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/themeable-browser/) - -Cordova Repo: [https://github.com/initialxy/cordova-plugin-themeablebrowser](https://github.com/initialxy/cordova-plugin-themeablebrowser) - - -In-app browser that allows styling. - - - diff --git a/src/@ionic-native/plugins/toast/readme.md b/src/@ionic-native/plugins/toast/readme.md deleted file mode 100644 index e2e5ddc3f..000000000 --- a/src/@ionic-native/plugins/toast/readme.md +++ /dev/null @@ -1,32 +0,0 @@ - - - Improve this doc - - -# Toast - - -``` -$ npm install @ionic-native/toast --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/toast/) - -Cordova Repo: [https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin) - - -This plugin allows you to show a native Toast (a little text popup) on iOS, Android and WP8. It's great for showing a non intrusive native notification which is guaranteed always in the viewport of the browser. - -Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the [Toast plugin docs](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin). - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/touchid/readme.md b/src/@ionic-native/plugins/touchid/readme.md deleted file mode 100644 index 5d6058e59..000000000 --- a/src/@ionic-native/plugins/touchid/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# TouchID - - -``` -$ npm install @ionic-native/touchid --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/touchid/) - -Cordova Repo: [https://github.com/EddyVerbruggen/cordova-plugin-touch-id](https://github.com/EddyVerbruggen/cordova-plugin-touch-id) - - -Scan the fingerprint of a user with the TouchID sensor. - -Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see the [TouchID plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-touch-id). - - -## Supported platforms - -- iOS - - - - - diff --git a/src/@ionic-native/plugins/twitter-connect/readme.md b/src/@ionic-native/plugins/twitter-connect/readme.md deleted file mode 100644 index 891e574f8..000000000 --- a/src/@ionic-native/plugins/twitter-connect/readme.md +++ /dev/null @@ -1,41 +0,0 @@ - - - Improve this doc - - -# Twitter Connect - - -``` -$ ionic plugin add twitter-connect-plugin --variable FABRIC_KEY=fabric_API_key -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/twitter-connect/) - -Cordova Repo: [https://github.com/ManifestWebDesign/twitter-connect-plugin](https://github.com/ManifestWebDesign/twitter-connect-plugin) - - -Plugin to use Twitter Single Sign On -Uses Twitter's Fabric SDK -```typescript -import {TwitterConnect} from '@ionic-native/twitter-connect'; - -function onSuccess(response) { - console.log(response); - - // Will console log something like: - // { - // userName: 'myuser', - // userId: '12358102', - // secret: 'tokenSecret' - // token: 'accessTokenHere' - // } -} - -TwitterConnect.login().then(onSuccess, onError); - -TwitterConnect.logout().then(onLogoutSuccess, onLogoutError); -``` - - - diff --git a/src/@ionic-native/plugins/vibration/readme.md b/src/@ionic-native/plugins/vibration/readme.md deleted file mode 100644 index 0632cb737..000000000 --- a/src/@ionic-native/plugins/vibration/readme.md +++ /dev/null @@ -1,32 +0,0 @@ - - - Improve this doc - - -# Vibration - - -``` -$ npm install @ionic-native/vibration --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/vibration/) - -Cordova Repo: [https://github.com/apache/cordova-plugin-vibration](https://github.com/apache/cordova-plugin-vibration) - - -Vibrates the device - - -## Supported platforms - -- Android -- iOS -- Windows 8.1 Phone -- Windows 8.1 -- Windows 10 - - - - - diff --git a/src/@ionic-native/plugins/video-editor/readme.md b/src/@ionic-native/plugins/video-editor/readme.md deleted file mode 100644 index 9dc42c335..000000000 --- a/src/@ionic-native/plugins/video-editor/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# VideoEditor - - -``` -$ npm install @ionic-native/video-editor --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/video-editor/) - -Cordova Repo: [https://github.com/jbavari/cordova-plugin-video-editor](https://github.com/jbavari/cordova-plugin-video-editor) - - -Edit videos using native device APIs - - -## Supported platforms - -- Android -- iOS -- Windows Phone 8 - - - - - diff --git a/src/@ionic-native/plugins/video-player/readme.md b/src/@ionic-native/plugins/video-player/readme.md deleted file mode 100644 index 4b6dbcb7b..000000000 --- a/src/@ionic-native/plugins/video-player/readme.md +++ /dev/null @@ -1,30 +0,0 @@ - - - Improve this doc - - -# VideoPlayer - - -``` -$ npm install @ionic-native/video-player --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/video-player/) - -Cordova Repo: [https://github.com/moust/cordova-plugin-videoplayer](https://github.com/moust/cordova-plugin-videoplayer) - - -A Codova plugin that simply allows you to immediately play a video in fullscreen mode. - -Requires Cordova plugin: `com.moust.cordova.videoplayer`. For more info, please see the [VideoPlayer plugin docs](https://github.com/moust/cordova-plugin-videoplayer). - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/webintent/readme.md b/src/@ionic-native/plugins/webintent/readme.md deleted file mode 100644 index 1bbbb19c2..000000000 --- a/src/@ionic-native/plugins/webintent/readme.md +++ /dev/null @@ -1,28 +0,0 @@ - - - Improve this doc - - -# WebIntent - - -``` -$ npm install @ionic-native/webintent --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/webintent/) - -Cordova Repo: [https://github.com/Initsogar/cordova-webintent.git](https://github.com/Initsogar/cordova-webintent.git) - - - - - -## Supported platforms - -- Android - - - - - diff --git a/src/@ionic-native/plugins/youtube-video-player/readme.md b/src/@ionic-native/plugins/youtube-video-player/readme.md deleted file mode 100644 index 3ad26b898..000000000 --- a/src/@ionic-native/plugins/youtube-video-player/readme.md +++ /dev/null @@ -1,29 +0,0 @@ - - - Improve this doc - - -# YoutubeVideoPlayer - - -``` -$ npm install @ionic-native/youtube-video-player --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/youtube-video-player/) - -Cordova Repo: [https://github.com/Glitchbone/CordovaYoutubeVideoPlayer](https://github.com/Glitchbone/CordovaYoutubeVideoPlayer) - - -Plays YouTube videos in Native YouTube App - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/z-bar/readme.md b/src/@ionic-native/plugins/z-bar/readme.md deleted file mode 100644 index 414c4b0e2..000000000 --- a/src/@ionic-native/plugins/z-bar/readme.md +++ /dev/null @@ -1,31 +0,0 @@ - - - Improve this doc - - -# ZBar - - -``` -$ npm install @ionic-native/z-bar --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/z-bar/) - -Cordova Repo: [https://github.com/tjwoon/csZBar](https://github.com/tjwoon/csZBar) - - -The ZBar Scanner Plugin allows you to scan 2d barcodes. - -Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the [zBar plugin docs](https://github.com/tjwoon/csZBar). - - -## Supported platforms - -- Android -- iOS - - - - - diff --git a/src/@ionic-native/plugins/zip/readme.md b/src/@ionic-native/plugins/zip/readme.md deleted file mode 100644 index c8a896949..000000000 --- a/src/@ionic-native/plugins/zip/readme.md +++ /dev/null @@ -1,21 +0,0 @@ - - - Improve this doc - - -# Zip - - -``` -$ npm install @ionic-native/zip --save -``` - -## [Usage Documentation](https://ionicframework.com/docs/v2/native/zip/) - -Cordova Repo: [https://github.com/MobileChromeApps/cordova-plugin-zip](https://github.com/MobileChromeApps/cordova-plugin-zip) - - -A Cordova plugin to unzip files in Android and iOS. - - -