Updated docs, jQuery version requirement, and testing page.

joe-meyer · Apr 15, 2014 · eb5e601 · eb5e601
1 parent 56777ad
commit eb5e601
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -3,14 +3,14 @@ Introduction
 
 PNotify is a JavaScript notification plugin, developed by SciActive. Formerly known as Pines Notify. It is designed to provide an unparalleled level of flexibility, while still being very easy to implement and use.
 
-PNotify provides desktop notifications based on the [web notifications draft](http://www.w3.org/TR/notifications/). If desktop notifications are not available or not allowed, PNotify will fall back to displaying the notice as a regular, in-browser notice.
+PNotify provides [desktop notifications](http://sciactive.com/pnotify/#web-notifications) based on the [web notifications draft](http://www.w3.org/TR/notifications/). If desktop notifications are not available or not allowed, PNotify will fall back to displaying the notice as a regular, in-browser notice.
 
-See http://sciactive.com/pnotify/ for more information and examples.
+See http://sciactive.com/pnotify/ for download, more information, and examples.
 
 Requirements
 ============
 
-jQuery (1.4 or higher) and either Bootstrap CSS or a jQuery UI Theme.
+jQuery (1.6 or higher) and either Bootstrap CSS, a jQuery UI Theme, or Web Notifications support.
 
 Getting Started
 ===============
@@ -135,6 +135,7 @@ Desktop Module
 `desktop: {`
 * `desktop: false` - Display the notification as a desktop notification.
 * `icon: null` - The URL of the icon to display. If false, no icon will show. If null, a default icon will show.
+* `tag: null` - Using a tag lets you update an existing notice, or keep from duplicating notices between tabs. If you leave tag null, one will be generated, facilitating the "update" function.
 
 `}`
 
@@ -193,7 +194,7 @@ Reference Module
 Callbacks Module
 ================
 
-The callback options all expect one argument, a function, which will be called when that event occurs. They can be included in the options object passed to $.pnotify() just like any other options. If the function returns false on the "before_open" or "before_close" callback, that event will be canceled.
+The callback options all expect one argument, a function, which will be called when that event occurs. They can be included in the options object passed to PNotify() just like any other options. If the function returns false on the "before_open" or "before_close" callback, that event will be canceled.
 
 * `before_init` - This option is called before the notice has been initialized. It accepts one argument, the options object.
 * `after_init` - This option is called after the notice has been initialized. It accepts one argument, the notice object.
@@ -205,4 +206,4 @@ The callback options all expect one argument, a function, which will be called w
 Additional Info
 ===============
 
-For examples/demos see http://sciactive.com/pnotify/
+See http://sciactive.com/pnotify/ for download, more information, and examples.
diff --git a/index.html b/index.html
@@ -899,7 +899,7 @@ <h4 class="modal-title" id="using-title">Using PNotify</h4>
 					<pre class="prettyprint">&lt;script type="text/javascript" src="pnotify.custom<em>.min</em>.js"&gt;&lt;/script&gt;
 &lt;link href="pnotify.custom<em>.min</em>.css" media="all" rel="stylesheet" type="text/css" /&gt;</pre>
 					<p>
-						You also need to include jQuery (1.4 or higher) and either Bootstrap CSS or a jQuery UI Theme.
+						You also need to include jQuery (1.6 or higher) and either Bootstrap CSS or a jQuery UI Theme.
 						<small>If you want to use jQuery UI effect animations, you also need to include the jQuery UI JavaScript.</small>
 					</p>
 					<p>

diff --git a/testing.html b/testing.html
@@ -1,25 +1,24 @@
 <html>
 <head>
 	<title>PNotify Testing</title>
-    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.js"></script>
-    <script type="text/javascript" src="jquery.pnotify.js"></script>
+    <script type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.6.4/jquery.js"></script>
+    <script type="text/javascript" src="pnotify.core.js"></script>
 
-    <link type="text/css" rel="stylesheet" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.17/themes/ui-lightness/jquery-ui.css" />
-    <link type="text/css" rel="stylesheet" href="includes/bootstrap/css/bootstrap.normal.css" />
-    <link type="text/css" rel="stylesheet" href="jquery.pnotify.default.css" />
-</head>                                                                                                                                                                        
-<body>                                                                                                                                                                         
+    <link type="text/css" rel="stylesheet" href="//ajax.googleapis.com/ajax/libs/jqueryui/1.8.17/themes/ui-lightness/jquery-ui.css" />
+    <link type="text/css" rel="stylesheet" href="includes/bootstrap3/css/bootstrap.css" />
+    <link type="text/css" rel="stylesheet" href="pnotify.core.css" />
+</head>
+<body>
     <h2>This is Foo - the home of a sticky note.</h2>
-    <script>                                                                                                                                                                   
+    <script>
         $(function(){
-			$.pnotify({
-				pnotify_title: 'Sticky Notice',
-				pnotify_text: 'I\'m a sticky notice.',
-				pnotify_hide: false
+			new PNotify({
+				title: 'Notice',
+				text: 'I\'m a notice.'
 			});
 			// If this blinky works, then it ran the above function.
 			$("h2").hide(400).show(400);
-		});                                           
-    </script>                                                                                                                                                                  
-</body>                                                                                                                                                                        
+		});
+    </script>
+</body>
 </html>