react-image-timeline - npm Package Compare versions

Comparing version 1.0.11 to 2.0.0

index.js

@@ -1,1 +0,1 @@
-module.exports = require('./dist/timline');
+module.exports = require('./dist/timline');

package.json

 {
   "name": "react-image-timeline",
-  "version": "1.0.11",
+  "version": "2.0.0",
   "main": "index.js",
@@ -61,3 +61,3 @@ "homepage": "http://aaron9000.github.io/react-image-timeline",
   ],
-  "author": "Aaron Geisler <[e-mail]>",
+  "author": "Aaron Geisler",
   "license": "MIT",
@@ -64,0 +64,0 @@ "bugs": {

README.md

@@ -0,1 +1,3 @@
+[![CircleCI](https://circleci.com/gh/aaron9000/react-image-timeline/tree/master.svg?style=svg)](https://circleci.com/gh/aaron9000/react-image-timeline/tree/master)
+
 # React Image Timeline
@@ -5,3 +7,3 @@
 
-***Updated for React 16***
+***v2.0.0 (React 16)***
 
@@ -32,22 +34,26 @@ ### Features
 
-
 #### Props
-|                      Key |                     Type |                 Required
+|                      Key |                     Type |                Required?
 |--------------------------|--------------------------|--------------------------|
-|                  events  |        array of "Event"  |                required  |
+|                  events  |        array of "Event"  |                     Yes  |
+|        customComponents  |      "CustomComponents"  |                          |
 |            reverseOrder  |                 boolean  |                          |
-|        customStartLabel  |               component  |                          |
-|          customEndLabel  |               component  |                          | 
-|            customHeader  |               component  |                          |
-|         customImageBody  |               component  |                          |
-|          customTextBody  |               component  |                          |
-|            customFooter  |               component  |                          |
 
+#### CustomComponents
+|                      Key |                     Type |                Required?
+|--------------------------|--------------------------|--------------------------|
+|                topLabel  |               component  |                          |
+|             bottomLabel  |               component  |                          | 
+|                  header  |               component  |                          |
+|               imageBody  |               component  |                          |
+|                textBody  |               component  |                          |
+|                  footer  |               component  |                          |
+
 #### Event
-|                      Key |                     Type |                 Required|
+|                      Key |                     Type |                Required?
 |--------------------------|--------------------------|--------------------------|
-|                    date  |                    date  |                required  |
-|                   title  |                  string  |                required  |
-|                imageUrl  |                  string  |                required  |
-|                    text  |                  string  |                required  |
+|                    date  |                    date  |                     Yes  |
+|                   title  |                  string  |                     Yes  |
+|                imageUrl  |                  string  |                     Yes  |
+|                    text  |                  string  |                     Yes  |
 |                 onClick  |                function  |                          |
@@ -62,3 +68,3 @@ |              buttonText  |                  string  |                          |
 {
-    date: Date.parse("2013-09-27"),
+    date: new Date(2013, 9, 27),
     text: "Sed leo elit, pellentesque sit amet congue quis, ornare nec lorem.",
@@ -90,3 +96,3 @@ title: "Cairo, Egypt",
     const {title, extras} = props.event;
-    
+
     // Custom data payload
@@ -102,6 +108,6 @@ const {customField} = extras;
 
-ReactDOM.render(<Timeline events={events} customHeader={CustomHeader}/>, document.getElementById('root'));
+ReactDOM.render(<Timeline events={events} customComponents={{header: CustomHeader}}/>, document.getElementById('root'));
 ```
 
-### Scripts
+---
 
@@ -117,3 +123,4 @@ #### Run Example Project
 ```
+*clone repository*
 npm run test
 ```

No alert changes

Improved metrics

Total package byte prevSize

364048

increased by0.22%

Number of package files

10

increased by25%

Lines of code

190

increased by0.53%

Number of lines in readme file

121

increased by6.14%

No dependency changes