-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
105 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
__*[NOTE]:*__ See [Instructions](Instructions.markdown) for these stub documentation files. (Remove this before you deploy your docs) | ||
|
||
|
||
# PLUGIN_NAME: Plugin API Docs | ||
|
||
| | | ||
| -------------------- | --------------------------------------------------------------- | ||
| __Type__ | [TYPE](http://docs.coronalabs.com/api/type/Library.html) | ||
| __Corona Store__ | [PLUGIN_NAME](http://store.coronalabs.com/plugin/PLUGIN_NAME) | ||
| __Keywords__ | | ||
| __See also__ | | ||
|
||
## Overview | ||
|
||
The PLUGIN_NAME plugin can be used in your [Corona](https://coronalabs.com/products/corona-sdk/) project. It enables you to... | ||
|
||
|
||
## Syntax | ||
|
||
local PLUGIN_NAME = require "plugin.PLUGIN_NAME" | ||
|
||
### Functions | ||
|
||
##### [PLUGIN_NAME.loadTable()](loadTable.markdown) | ||
|
||
##### [PLUGIN_NAME.printTable()](printTable.markdown) | ||
|
||
##### [PLUGIN_NAME.saveTable()](saveTable.markdown) | ||
|
||
##### [PLUGIN_NAME.FUNCTION()](FUNCTION.markdown) | ||
|
||
|
||
### Properties | ||
|
||
##### [PLUGIN_NAME.PROPERTY](PROPERTY.markdown) | ||
|
||
## Project Configuration | ||
|
||
### Corona Store Activation | ||
|
||
In order to use this plugin, you must activate the plugin at the [Corona Store](http://store.coronalabs.com/plugin/PLUGIN_NAME). | ||
|
||
|
||
### SDK | ||
|
||
When you build using the Corona Simulator, the server automatically takes care of integrating the plugin into your project. | ||
|
||
All you need to do is add an entry into a `plugins` table of your `build.settings`. The following is an example of a minimal `build.settings` file: | ||
|
||
`````` | ||
settings = | ||
{ | ||
plugins = | ||
{ | ||
-- key is the name passed to Lua's 'require()' | ||
["plugin.PLUGIN_NAME"] = | ||
{ | ||
-- required | ||
publisherId = "REVERSE_PUBLISHER_URL", | ||
}, | ||
}, | ||
} | ||
`````` | ||
|
||
### Enterprise | ||
|
||
If you have activated this plugin, you can download this plugin from the corresponding plugin page in the [Corona Store](http://store.coronalabs.com/plugin/PLUGIN_NAME). | ||
|
||
|
||
## Platform-specific Notes | ||
|
||
[Insert discussion on issues specific to iOS/Android/etc, or to specific devices] | ||
|
||
|
||
## Resources | ||
|
||
### Sample Code | ||
|
||
You can access sample code [here](SAMPLE_CODE_URL). | ||
|
||
### Support | ||
|
||
More support is available from the PUBLISHER_NAME team: | ||
|
||
* [E-mail](mailto://PUBLISHER_CONTACT@PUBLISHER_URL) | ||
* [Forum](http://FORUM_URL) | ||
* [Plugin Publisher](http://PUBLISHER_URL) | ||
|
||
|
||
## Compatibility | ||
|
||
| Platform | Supported | ||
| ---------------------------- | ---------------------------- | ||
| iOS | No | ||
| Android | No | ||
| Android (GameStick) | No | ||
| Android (Kindle) | No | ||
| Android (NOOK) | No | ||
| Android (Ouya) | No | ||
| Mac App | No | ||
| Win32 App | No | ||
| Windows Phone 8 | No | ||
| Corona Simulator (Mac) | No | ||
| Corona Simulator (Win) | No | ||
|