diff --git a/README.md b/README.md index 43648d0..3d58746 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,74 @@ under the License. --> -# org.apache.cordova.splashscreen +# cordova-plugin-splashscreen [![Build Status](https://travis-ci.org/apache/cordova-plugin-splashscreen.svg)](https://travis-ci.org/apache/cordova-plugin-splashscreen) -Plugin documentation: [doc/index.md](doc/index.md) +This plugin displays and hides a splash screen during application launch. + +## Installation + + cordova plugin add cordova-plugin-splashscreen + + +## Supported Platforms + +- Amazon Fire OS +- Android +- BlackBerry 10 +- iOS +- Windows Phone 7 and 8 +- Windows 8 + + +## Methods + +- splashscreen.show +- splashscreen.hide + +### Android Quirks + +In your config.xml, you need to add the following preferences: + + + + +Where foo is the name of the splashscreen file, preferably a 9 patch file. Make sure to add your splashcreen files to your res/xml directory under the appropriate folders. The second parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) +for more information. + +## splashscreen.hide + +Dismiss the splash screen. + + navigator.splashscreen.hide(); + + +### BlackBerry 10, WP8, iOS Quirk + +The `config.xml` file's `AutoHideSplashScreen` setting must be +`false`. To delay hiding the splash screen for two seconds, add a +timer such as the following in the `deviceready` event handler: + + setTimeout(function() { + navigator.splashscreen.hide(); + }, 2000); + +## splashscreen.show + +Displays the splash screen. + + navigator.splashscreen.show(); + + +Your application cannot call `navigator.splashscreen.show()` until the app has +started and the `deviceready` event has fired. But since typically the splash +screen is meant to be visible before your app has started, that would seem to +defeat the purpose of the splash screen. Providing some configuration in +`config.xml` will automatically `show` the splash screen immediately after your +app launch and before it has fully started and received the `deviceready` +event. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) +for more information on doing this configuration. For this reason, it is +unlikely you need to call `navigator.splashscreen.show()` to make the splash +screen visible for app startup. + diff --git a/doc/index.md b/doc/index.md deleted file mode 100644 index c3070cc..0000000 --- a/doc/index.md +++ /dev/null @@ -1,88 +0,0 @@ - - -# org.apache.cordova.splashscreen - -This plugin displays and hides a splash screen during application launch. - -## Installation - - cordova plugin add org.apache.cordova.splashscreen - - -## Supported Platforms - -- Amazon Fire OS -- Android -- BlackBerry 10 -- iOS -- Windows Phone 7 and 8 -- Windows 8 - - -## Methods - -- splashscreen.show -- splashscreen.hide - -### Android Quirks - -In your config.xml, you need to add the following preferences: - - - - -Where foo is the name of the splashscreen file, preferably a 9 patch file. Make sure to add your splashcreen files to your res/xml directory under the appropriate folders. The second parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) -for more information. - -## splashscreen.hide - -Dismiss the splash screen. - - navigator.splashscreen.hide(); - - -### BlackBerry 10, WP8, iOS Quirk - -The `config.xml` file's `AutoHideSplashScreen` setting must be -`false`. To delay hiding the splash screen for two seconds, add a -timer such as the following in the `deviceready` event handler: - - setTimeout(function() { - navigator.splashscreen.hide(); - }, 2000); - -## splashscreen.show - -Displays the splash screen. - - navigator.splashscreen.show(); - - -Your application cannot call `navigator.splashscreen.show()` until the app has -started and the `deviceready` event has fired. But since typically the splash -screen is meant to be visible before your app has started, that would seem to -defeat the purpose of the splash screen. Providing some configuration in -`config.xml` will automatically `show` the splash screen immediately after your -app launch and before it has fully started and received the `deviceready` -event. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html) -for more information on doing this configuration. For this reason, it is -unlikely you need to call `navigator.splashscreen.show()` to make the splash -screen visible for app startup. -