stardust - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

package.json

 {
   "name": "stardust",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Semantic UI components for React.",
   "main": "index.js",
   "files": [
-    "src/components"
+    "src"
   ],
@@ -9,0 +9,0 @@ "scripts": {

README.md

@@ -1,17 +0,4 @@
-[![Wercker Status](https://img.shields.io/wercker/ci/TechnologyAdvice/stardust.svg?style=flat-square)](https://app.wercker.com/TechnologyAdvice/stardust) [![Code Climate](https://img.shields.io/codeclimate/github/TechnologyAdvice/stardust.svg?style=flat-square)](https://codeclimate.com/github/TechnologyAdvice/stardust) [![Gemnasium](https://img.shields.io/gemnasium/TechnologyAdvice/stardust.svg?style=flat-square)](https://gemnasium.com/TechnologyAdvice/stardust)
-```
-                                        .
-                                 *   .     .   . 
-                                      . (*.) .    * .
-                                  .  ( .(.. ) )  
-                                 . .( (..*  ).*) . 
-                                    ( *  . ). .)  .
-                                   .  ( (. *.) . 
-                                       .  .    *           stardust
-                                    .*       .
-                         
-```
->[React](https://facebook.github.io/react/) component library based on [Semantic UI](http://semantic-ui.com/).
+# Stardust [![Wercker Status](https://img.shields.io/wercker/ci/TechnologyAdvice/stardust.svg?style=flat-square)](https://app.wercker.com/TechnologyAdvice/stardust) [![Code Climate](https://img.shields.io/codeclimate/github/TechnologyAdvice/stardust.svg?style=flat-square)](https://codeclimate.com/github/TechnologyAdvice/stardust) [![Gemnasium](https://img.shields.io/gemnasium/TechnologyAdvice/stardust.svg?style=flat-square)](https://gemnasium.com/TechnologyAdvice/stardust)
 
-## Install
+[React](https://facebook.github.io/react/) component library based on [Semantic UI](http://semantic-ui.com/).
 
@@ -23,3 +10,3 @@ ```
 ## Learn
-Checkout the [Documentation](https://technologyadvice.github.io/stardust/).
+Check out the [Documentation](https://technologyadvice.github.io/stardust/).
 
@@ -29,2 +16,37 @@ Review our [Component Guidelines]
 
+## Getting Started
+Hey, we're in development.  Minor versions may introduce **breaking changes until v1**.
+
+### Babel
+Stardust is built with ES6 and ES7.  Use Babel with the [stage 0](http://babeljs.io/docs/usage/experimental/#enable-by-stage) option to enable these features.  We suggest using a [.babelrc](http://babeljs.io/docs/usage/babelrc/) file, which is also picked up by the webpack [babel-loader](https://github.com/babel/babel-loader).
+
+### Usage
+
+**ES6**
+```jsx
+import React, {Component} from 'react';
+import {Button} from 'stardust';
+
+export default class TryStardust extends Component {
+  render() {
+    return <Button>Hello</Button>;
+  }
+}
+```
+
+**ES5**
+```js
+var React = require('react');
+var stardust = require('stardust');
+var Button = stardust.Button;
+
+var TryStardust = React.createClass({
+  render: function() {
+    return <Button>Make it happen!</Button>;
+  }
+});
+
+module.exports = TryStardust;
+```
+
 ## Develop
@@ -31,0 +53,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

26685

increased by365.14%

Number of package files

28

increased by833.33%

Lines of code

830

increased by1331.03%

Number of lines in readme file

69

increased by46.81%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes