Skip to content

Commit

Permalink
add docs and license
Browse files Browse the repository at this point in the history
  • Loading branch information
isis committed Apr 1, 2013
1 parent 9235d4e commit cf216c8
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 23 deletions.
8 changes: 7 additions & 1 deletion LICENSE
@@ -1 +1,7 @@
TODO: place your license here and we'll include it in the module distribution
Copyright (c) 2013 Katsumi ISHIDA. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8 changes: 7 additions & 1 deletion LICENSE.txt
@@ -1 +1,7 @@
Place your license text here. This file will be incorporated with your app at package time.
Copyright (c) 2013 Katsumi ISHIDA. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
56 changes: 39 additions & 17 deletions documentation/index.md
@@ -1,39 +1,61 @@
# bootbroadcastreceiver Module
# *BootBroadcastReceiver Module*

## Description

TODO: Enter your module description here
*BootBroadcastReceiver Module* make your Titanium app launch when Android device boot and/or your app package replaced.

## Accessing the bootbroadcastreceiver Module
*BootBroadcastReceiver Module* receives "android.intent.action.BOOT_COMPLETED" and "android.intent.action.PACKAGE_REPLACED", and launch your Titanium app.

To access this module from JavaScript, you would do the following:
## Accessing the bootbroadcastreceiver Module

*BootBroadcastReceiver Module* no neads creation of Object of Module like below:
var bootbroadcastreceiver = require("jp.isisredirect.bootbroadcastreceiver");

The bootbroadcastreceiver variable is a reference to the Module object.
You need only import module by <module> in tiapp.xml :

## Reference
<modules>
<module platform="android" version="2.0">jp.isisredirect.bootbroadcastreceiver</module>
</modules>

## Requrement

TODO: If your module has an API, you should document
the reference here.
Android min-sdk: Android 2.2 (API Level 8)
Titanium 2.1.0.GA

### ___PROJECTNAMEASIDENTIFIER__.function
## Reference

### module method

TODO: This is an example of a module function.
+ non

### ___PROJECTNAMEASIDENTIFIER__.property
### module property

TODO: This is an example of a module property.
+ non

## Usage

TODO: Enter your usage example here
You need import module only.

## Author

TODO: Enter your author name, email and other contact
details you want to share here.
Kastumi ISHIDA (isis re-direct) in k.i.office.

## License
isis.redirect4@gmail.com

TODO: Enter your license/legal information here.
## License
Copyright 2013 Katsumi ISHIDA. All rights reserved.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
USA.
8 changes: 4 additions & 4 deletions manifest
Expand Up @@ -4,10 +4,10 @@
#
version: 2.0
apiversion: 2
description: My module
author: Your Name
license: Specify your license
copyright: Copyright (c) 2013 by Your Company
description: BootBroadcastReceiver module
author: Katsumi ISHIDA
license: see license file
copyright: Copyright (c) 2013 Katsumi ISHIDA. All rights reserved.


# these should not be edited
Expand Down

0 comments on commit cf216c8

Please sign in to comment.