ink-table - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "ink-table",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A table component for Ink.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,2 +0,6 @@
-# ink-table [![Build Status](https://travis-ci.org/maticzav/ink-table.svg?branch=master)](https://travis-ci.org/maticzav/ink-table)
+# ink-table
+
+[![Build Status](https://travis-ci.org/maticzav/ink-table.svg?branch=master)](https://travis-ci.org/maticzav/ink-table)
+[![npm version](https://badge.fury.io/js/ink-table.svg)](https://badge.fury.io/js/ink-table)
+
 > A table component for [Ink](https://github.com/vadimdemedes/ink).
@@ -6,5 +10,5 @@
 
+```bash
+ npm install ink-table
 ```
-$ npm install ink-table
-```
 
@@ -15,14 +19,42 @@ ## Usage
 const data = [
-  {name: 'Sosa Saunders', gender: 'male', age: 17, email: '[e-mail]', phone: '[phone]'},
-  {name: 'Angelina Kirk', gender: 'female', age: 3, email: '[e-mail]', phone: '[phone]'},
-  {name: 'Bradford Rosales', gender: 'male', age: 20, email: '[e-mail]', phone: '[phone]'},
-  {name: 'Gwen Schroeder', gender: 'female', age: 17, email: '[e-mail]', phone: '[phone]'},
-  {name: 'Ellison Mann', gender: 'male', age: 5, email: '[e-mail]', phone: '[phone]'}
-]
+  {
+    name: "Sosa Saunders",
+    gender: "male",
+    age: 17,
+    email: "[e-mail]",
+    phone: "[phone]"
+  },
+  {
+    name: "Angelina Kirk",
+    gender: "female",
+    age: 3,
+    email: "[e-mail]",
+    phone: "[phone]"
+  },
+  {
+    name: "Bradford Rosales",
+    gender: "male",
+    age: 20,
+    email: "[e-mail]",
+    phone: "[phone]"
+  },
+  {
+    name: "Gwen Schroeder",
+    gender: "female",
+    age: 17,
+    email: "[e-mail]",
+    phone: "[phone]"
+  },
+  {
+    name: "Ellison Mann",
+    gender: "male",
+    age: 5,
+    email: "[e-mail]",
+    phone: "[phone]"
+  }
+];
 
-const Basic = () => (
-  <Table data={data}/>
-)
+const Basic = () => <Table data={data} />;
 
-render(<Basic/>)
+render(<Basic />);
 ```
@@ -32,23 +64,26 @@
 
-
 ## Props
 
-#### data `array<object>`
+### data `array<object>`
+
 > List of all the values (rows).
 
-#### padding `number`
+### padding `number`
+
 > Offset inside each cell. This is considered one side value (set to 2 will have 2 spaces on the left and on the right - 4 combined).
 
-#### header `({children}) => h`
+### header `({children}) => h`
+
 > A component used as header cell. Value is passed as `children` prop.
-_(Recommend using `<Color/>` with `chalk` props.)_
+> _(Recommend using `<Color/>` with `chalk` props.)_
 
-#### cell `({children}) => h`
+### cell `({children}) => h`
+
 > A component used as regular cell. Value is passed as `children` prop.
-_(Recommend using `<Color/>` with `chalk` props.)_
+> _(Recommend using `<Color/>` with `chalk` props.)_
 
-#### skeleton `({children}) => h`
-> A component used as skeleton (lines and crosses ...). Value is passed as `children` prop.   
-_(Recommend using `<Color/>` with `chalk` props.)_
+### skeleton `({children}) => h`
 
+> A component used as skeleton (lines and crosses ...). Value is passed as `children` prop.
+> _(Recommend using `<Color/>` with `chalk` props.)_
 
@@ -55,0 +90,0 @@ ## License

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9098

increased by2.45%

Number of lines in readme file

90

increased by63.64%

No dependency changes