react-event-calendar - npm Package Compare versions

Comparing version 0.0.8 to 0.0.9

gulpfile.js

@@ -30,21 +30,19 @@ var gulp = require('gulp');
 
-	example: false
+	example: {
+		src: 'example/src',
+		dist: 'example/dist',
+		files: [
+			'index.html',
+			'.gitignore',
+		],
+		scripts: [
+			'example.js',
+		],
+		less: [
+			'example.less',
+		],
+	},
 
-	// example: {
-	// 	src: 'example/src',
-	// 	dist: 'example/dist',
-	// 	files: [
-	// 		'index.html',
-	// 		'.gitignore',
-	// 	],
-	// 	scripts: [
-	// 		'example.js',
-	// 	],
-	// 	less: [
-	// 		'example.less',
-	// 	],
-	// },
-
 };
 
 initGulpTasks(gulp, taskConfig);

package.json

 {
   "name": "react-event-calendar",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "react-event-calendar",
@@ -5,0 +5,0 @@ "main": "lib/ReactEventCalendar.js",

README.md

 # react-event-calendar
 
-__COMPONENT DESCRIPTION GOES HERE__
+Coming Soon... a much better description than this!
 
@@ -33,8 +33,21 @@
 
-__EXPLAIN USAGE HERE__
+Use this component to display a month view of a calendar with supplied event duration indicators.
 
 ```
-var ReactEventCalendar = require('react-event-calendar');
+const ReactEventCalendar = require('react-event-calendar');
 
-<ReactEventCalendar>Example</ReactEventCalendar>
+const events = [
+    {
+        start: '2015-07-20',
+        end: '2015-07-02',
+        title: 'test event',
+        description: 'This is a test description of an event',
+    },
+];
+
+<ReactEventCalendar 
+    events={events}
+    month={7}
+    year={2015}
+    events={events} />
 ```
@@ -44,7 +57,9 @@
 
-* __DOCUMENT PROPERTIES HERE__
+* ```events```:```Array``` Array of event objects to be represented on the calendar
+* ```month```: ```Integer``` Selected Month to display
+* ```year```: ```Integer``` Selected Year to display
 
 ### Notes
 
-__ADDITIONAL USAGE NOTES__
+Requires Array.prototype.find and Arra.prototype.some.  Please include ES6 Array polyfill for unsupported browsers.
 
@@ -51,0 +66,0 @@

No alert changes

Improved metrics

Total package byte prevSize

49060

increased by2.66%

Lines of code

834

increased by1.34%

Number of lines in readme file

77

increased by24.19%

No dependency changes