You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2015/03/14 03:41:16 UTC
cordova-plugin-splashscreen git commit: CB-8653 Updated Readme
Repository: cordova-plugin-splashscreen
Updated Branches:
refs/heads/master 5afde1c62 -> 6ce8a3286
CB-8653 Updated Readme
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/commit/6ce8a328
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/tree/6ce8a328
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/diff/6ce8a328
Branch: refs/heads/master
Commit: 6ce8a32865716a3ec6bb266115487c2294f63956
Parents: 5afde1c
Author: Steve Gill <st...@gmail.com>
Authored: Fri Mar 13 19:41:09 2015 -0700
Committer: Steve Gill <st...@gmail.com>
Committed: Fri Mar 13 19:41:09 2015 -0700
----------------------------------------------------------------------
README.md | 70 +++++++++++++++++++++++++++++++++++++++++--
doc/index.md | 88 -------------------------------------------------------
2 files changed, 68 insertions(+), 90 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/blob/6ce8a328/README.md
----------------------------------------------------------------------
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
[](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:
+
+ <preference name="SplashScreen" value="foo" />
+ <preference name="SplashScreenDelay" value="10000" />
+
+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.
+
http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/blob/6ce8a328/doc/index.md
----------------------------------------------------------------------
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 @@
-<!---
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-# 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:
-
- <preference name="SplashScreen" value="foo" />
- <preference name="SplashScreenDelay" value="10000" />
-
-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.
-
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org