react-data-matrix 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +14 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,6 +5,20 @@ React Matrix table shows relationships between two or more variables in a data s
5
5
 
6
6
  The most common usage for a table like React Matrix, is to display the __likelihood__ and __consequence__ "scores" of __risks/hazards__, this can be for anything from Corporate, Work Health Safety and Environment risks, and more.
7
7
 
8
+ # Usage
9
+
10
+ ```js
11
+ import { ReactMatrix } from "react-data-matrix";
12
+
13
+ const App = () => {
14
+ ...
15
+
16
+ return (
17
+ <ReactMatrix data={data} {...seeOtherPropsBelow} />
18
+ )
19
+ }
20
+ ```
21
+
8
22
  # Expected Data Structure
9
23
  - See ```./src/lib/utils/data.js``` for an example of the data, this can be used for testing if needed,
10
24
  or an example of how to construct/deconstruct your data objects from your api.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-data-matrix",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "private": false,
5
5
  "license": "MIT",
6
6
  "homepage": "https://github.com/bronz3beard/react-matrix",