orbital-list - npm Package Compare versions

Comparing version 0.1.9-rc.4 to 0.1.9-rc.5

package.json

 {
   "name": "orbital-list",
-  "version": "0.1.9-rc.4",
+  "version": "0.1.9-rc.5",
   "description": "A React library to display data using circles, orbits, and planets.",
@@ -5,0 +5,0 @@ "author": "lsenta",

README.md

@@ -7,4 +7,8 @@ # orbital-list
 
+Visit [laurentsenta.com/orbital-list](http://www.laurentsenta.com/orbital-list/) for an interactive example.
+
 ## Install
 
+With npm:
+
 ```bash
@@ -14,13 +18,47 @@ npm install --save orbital-list
 
+With yarn:
+
+```bash
+yarn add orbital-list
+```
+
 ## Usage
 
+The library provides a set of components.
+
 ```tsx
 import React, { Component } from 'react'
 
-import MyComponent from 'orbital-list'
-import 'orbital-list/dist/index.css'
+import {
+  Dial,
+  Hand,
+  Label,
+  Orbit,
+  OrbitalList,
+  Place,
+  Planet,
+  Slice
+} from 'orbital-list'
 
 class Example extends Component {
   render() {
-    return <MyComponent />
+    return (
+      <OrbitalList>
+        <Dial color='#1f2041' />
+        <Slice
+          color='rgba(75, 63, 114, 1)'
+          length={0.5}
+          angleStart={180}
+          angleEnd={202.5}
+        />
+        <Place
+          angle={180}
+          distance={0.8}
+          style={{ color: '#ed254e', fontSize: '1.2rem', fontWeight: 'bold' }}
+        >
+          <button>Hello</button>
+        </Place>
+        <Orbit color='rgba(244, 205, 205, 1)' radius={0.15} />
+      </OrbitalList>
+    )
   }
@@ -27,0 +65,0 @@ }

No alert changes

Improved metrics

Total package byte prevSize

160517

increased by0.45%

Number of lines in readme file

81

increased by88.37%

No dependency changes