Commit cf7ca7d7 authored by Sebastián Katzer's avatar Sebastián Katzer
Browse files

Small doc changes

parent 92393e6e

CHANGELOG.md

+3 −0
Changes for CHANGELOG.md: 3 added lines, 0 removed lines.
Original line number Diff line number Diff line 
## ChangeLog

#### Version 0.8.0 (not yet released)

- [enhancement:] android 2.1 support added (Thanks to **khizarsonu**)



#### Version 0.7.4 (22.03.2014)

- [bugfix:] Platform specific properties were ignored.

- [bugfix:] `cancel` may throw an error if the OS returns NIL values (iOS).

README.md

+15 −3
Changes for README.md: 15 added lines, 3 removed lines.
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ The purpose of the plugin is to create an platform independent javascript interf 
- **iOS**<br>

See [Local and Push Notification Programming Guide][ios_notification_guide] for detailed informations and screenshots.



- **Android** *(SDK >=11)*<br>

- **Android** *(SDK >=7)*<br>

See [Notification Guide][android_notification_guide] for detailed informations and screenshots.



- **WP8**<br>
@@ -35,7 +35,7 @@ See [Local notifications for Windows Phone][wp8_notification_guide] for detailed 
- [org.apache.cordova.device][apache_device_plugin] *(since v0.6.0)*





# Installation

## Installation

The plugin can either be installed into the local development environment or cloud based through [PhoneGap Build][PGB].



### Adding the Plugin to your project
@@ -68,6 +68,15 @@ or to use an specific version: 
More informations can be found [here][PGB_plugin].





## ChangeLog

#### Version 0.8.0 (not yet released)

- [enhancement:] android 2.1 support added (Thanks to **khizarsonu**)



#### Further informations

- See [CHANGELOG.md][changelog] to get the full changelog for the plugin.

- See the [v0.8.x TODO List][todo_list] for upcomming changes and other things.





## Using the plugin

The plugin creates the object ```window.plugin.notification.local``` with the following methods:
@@ -435,7 +444,7 @@ The launch mode for the main activity has to be set to `singleInstance` 


## License



This software is released under the [Apache 2.0 License](http://opensource.org/licenses/Apache-2.0).

This software is released under the [Apache 2.0 License][apache2_license].



© 2013-2014 appPlant UG, Inc. All rights reserved
@@ -448,6 +457,8 @@ This software is released under the [Apache 2.0 License](http://opensource.org/l 
[CLI]: http://cordova.apache.org/docs/en/3.0.0/guide_cli_index.md.html#The%20Command-line%20Interface

[PGB]: http://docs.build.phonegap.com/en_US/3.3.0/index.html

[PGB_plugin]: https://build.phonegap.com/plugins/413

[changelog]: CHANGELOG.md

[todo_list]: issues/164

[onadd]: #get-notified-when-a-local-notification-has-been-scheduled

[onclick]: #get-notified-when-the-user-has-been-clicked-on-a-local-notification

[oncancel]: #get-notified-when-a-local-notification-has-been-canceled
@@ -462,3 +473,4 @@ This software is released under the [Apache 2.0 License](http://opensource.org/l 
[isscheduled]: #check-wether-a-notification-with-an-id-is-scheduled

[examples]: #examples

[setdefaults-example]: #change-the-default-value-of-local-notification-properties

[apache2_license]: http://opensource.org/licenses/Apache-2.0

plugin.xml

+3 −2
Changes for plugin.xml: 3 added lines, 2 removed lines.
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ 


    <name>LocalNotification</name>



    <description>A bunch of local-notification plugins for Cordova 3.x.x</description>

    <description>The purpose of the plugin is to create an platform independent javascript interface for Cordova based mobile applications to access the specific Notification API on each platform.</description>

    <repo>https://github.com/katzer/cordova-plugin-local-notifications.git</repo>

    <keywords>notification, local notification, alarm, scheduler, tile, live tiles, ios, android, windows phone 8, wp8</keywords>

    <license>Apache 2.0</license>
@@ -76,8 +76,9 @@ 
        <config-file target="AndroidManifest.xml" parent="/manifest">

            <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

        </config-file>

<!--libs/android/android-support-v4.jar-->



        <lib-file src="libs/android/android-support-v4.jar" />



        <source-file src="src/android/LocalNotification.java" target-dir="src/de/appplant/cordova/plugin/localnotification" />

        <source-file src="src/android/Receiver.java"          target-dir="src/de/appplant/cordova/plugin/localnotification" />

        <source-file src="src/android/Options.java"           target-dir="src/de/appplant/cordova/plugin/localnotification" />