CB-5658 Add doc.index.md for Splashscreen plugin

This commit is contained in:
Andrew Grieve
2013-12-18 20:59:29 -05:00
parent c2d22c0671
commit a5d40d0a95
2 changed files with 112 additions and 14 deletions
+18 -14
View File
@@ -1,18 +1,22 @@
cordova-plugin-splashscreen
----------------------------
<!---
license: 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
For Android,
http://www.apache.org/licenses/LICENSE-2.0
In your config.xml, you need to add the following preference
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.
-->
`<preference name="splashscreen" value="foo" />`
# org.apache.cordova.splashscreen
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.
For Android, you also have to edit your projects main java file. You must add a second parameter representing a time delay to your super.loadUrl.
`super.loadUrl(Config.getStartUrl(), 10000);`
To install this plugin, follow the [Command-line Interface Guide](http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface).
If you are not using the Cordova Command-line Interface, follow [Using Plugman to Manage Plugins](http://cordova.apache.org/docs/en/edge/plugin_ref_plugman.md.html).
Plugin documentation: [doc/index.md](doc/index.md)