Updated README.md

nickmcelligott · Aug 26, 2013 · d5cc5f8 · d5cc5f8
1 parent 719d2fd
commit d5cc5f8
Showing 1 changed file with 69 additions and 63 deletions.
diff --git a/calendar/README.md b/calendar/README.md
@@ -11,68 +11,74 @@ You also need to make sure that your `config.platform.xml` file has the correct
 
 
 ## Readme
-//  Cordova Calendar Plugin iOS and Android
-//
-//  Author: Felix Montanez
-//
-//  Collaborators:
-//  Michael Brooks
-//
-//  Adapted for Steroids by AppGyver
-//
-//  Notes: this is a basic plugin which creates an event to the user's local calendar. There are methods that I'm working on for fetching an event, modifying and deleting
-//  events in the calendar.
-//
-//  Usage Example: I put the code in my JS file that I'm calling the
-//  createEvent function. Declared cal as a global variable, then
-//  onDeviceReady, i declared cal = window.plugins.calendarPlugin
-//
-//  The plugin is meant to be dynamic to pass the different variables from
-//  the application to the iphone's native calendar
-//
-//  Dependencies: You will need to add the EventKit framework and the EventKitUI framework
-//
-//  Code:
-//
-//  var cal;
-//  cal = window.plugins.calendarPlugin
-//
-//  function call in Javascript:
-//
-//  createEvent : function(title,location,notes, startDate, endDate, calendarName){
-//            var title= "My Appt";
-//            var location = "Los Felix";
-//            var notes = "me testing";
-//            var startDate = "2012-01-23 09:30:00";
-//            var endDate = "2012-01-23 12:30:00";
-//            var calendarName = "Work"; // optional
-//
-//            cal.createEvent(title,location,notes,startDate,endDate, calendarName);
-//        },
-//
-//
-//  Which can also be written as:
-//
-//  function createEvent(title,location,notes, startDate, endDate, calendarName){
-//      var title= "My Appt";
-//      var location = "Los Felix";
-//      var notes = "me testing";
-//      var startDate = "2012-01-23 09:30:00";
-//      var endDate = "2012-01-23 12:30:00";
-//      var calendarName = "Work";  // optional
-//
-//      cal.createEvent(title,location,notes,startDate,endDate, calendarName);
-//  }
-//
-//  Also, there is a method "getCalendarList" which provides a list of calendar titles if you want
-//  pass in the title as the last parameter to createEvent to specify a calendar other than the default.
-//  call with:
-//     window.plugins.calendarPlugin.getCalendarList(successCallback, failureCallback);
-//
-//  The example I've written, although the function is receiving variables,
-//  for testing I declared the necessary variables. You will need to comment these out and pass
-//  your variables normally through the function call.
-//
+### Cordova Calendar Plugin iOS and Android
+
+Author: Felix Montanez
+
+Collaborators:
+Michael Brooks
+
+Adapted for Steroids by AppGyver
+
+Notes: this is a basic plugin which creates an event to the user's local calendar. There are methods that I'm working on for fetching an event, modifying and deleting
+events in the calendar.
+
+Usage Example: I put the code in my JS file that I'm calling the
+createEvent function. Declared cal as a global variable, then
+onDeviceReady, i declared cal = window.plugins.calendarPlugin
+
+The plugin is meant to be dynamic to pass the different variables from
+the application to the iphone's native calendar
+
+Code:
+
+```
+var cal;
+cal = window.plugins.calendarPlugin
+```
+
+
+function call in Javascript:
+
+```
+createEvent : function(title,location,notes, startDate, endDate, calendarName){
+          var title= "My Appt";
+          var location = "Los Felix";
+          var notes = "me testing";
+          var startDate = "2012-01-23 09:30:00";
+          var endDate = "2012-01-23 12:30:00";
+          var calendarName = "Work";  optional
+
+          cal.createEvent(title,location,notes,startDate,endDate, calendarName);
+      },
+```
+
+Which can also be written as:
+
+```
+function createEvent(title,location,notes, startDate, endDate, calendarName){
+    var title= "My Appt";
+    var location = "Los Felix";
+    var notes = "me testing";
+    var startDate = "2012-01-23 09:30:00";
+    var endDate = "2012-01-23 12:30:00";
+    var calendarName = "Work";   optional
+
+    cal.createEvent(title,location,notes,startDate,endDate, calendarName);
+}
+```
+
+Also, there is a method "getCalendarList" which provides a list of calendar titles if you want
+pass in the title as the last parameter to createEvent to specify a calendar other than the default.
+call with:
+```
+   window.plugins.calendarPlugin.getCalendarList(successCallback, failureCallback);
+```
+
+The example I've written, although the function is receiving variables,
+for testing I declared the necessary variables. You will need to comment these out and pass
+your variables normally through the function call.
+
 
 
 License
@@ -85,4 +91,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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.