react-heat-calendar - npm Package Compare versions

Comparing version 1.0.0 to 1.0.2

package.json

 {
   "name": "react-heat-calendar",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "react heat calendar, which is like a Github's contribution calendar",
@@ -5,0 +5,0 @@ "main": "./build/index.js",

README.md

@@ -1,20 +0,32 @@
-# react heat calendar
+# React Heat Calendar
 
-Get the AMD module located at `react-heat-calendar.js` and include it in your project.
+Like a Github's contribution calendar.
 
-Here is a sample integration:
+## Installation
 
-```js
-require.config({
-  paths: {
-    'react': 'vendor/bower_components/react/react',
-    'ReactHeatCalendar': 'react-heat-calendar'
-  }
-});
+Install the npm module:
 
-require(['react', 'ReactHeatCalendar'], function(React, ReactHeatCalendar) {
+```bash
+yarn add react-heat-calendar
+# Or
+npm install react-heat-calendar
+```
 
-  React.render(React.createElement(ReactHeatCalendar), document.getElementById('widget-container'));
+## Usage
 
-});
+Import the component:
+
+```javascript
+import HeatCalendar from 'react-heat-calendar';
+
+<HeatCalendar
+  beginDate={new Date('2016-12-01')}
+  endDate={new Date('2017-01-31')}
+  data={[
+    { date: '2016-12-02', someAttr: "foo" },
+    { date: '2016-12-03', someAttr: "bar" },
+    { date: '2016-12-03', someAttr: "baz" },
+    // ...and so on
+  ]}
+/>
 ```
@@ -21,0 +33,0 @@

No alert changes

Improved metrics

Total package byte prevSize

14884

0.48%

Number of lines in readme file

40

42.86%

No dependency changes