react-lorem-component - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

index.js

@@ -33,3 +33,3 @@ "use strict";
 
-      if (this.props.ordered === true) {
+      if (this.props.ordered) {
         wrapper = React.DOM.ol;
@@ -36,0 +36,0 @@ } else {

package.json

 {
   "name": "react-lorem-component",
-  "version": "0.5.0",
-  "description": "A component for React that renders paragraph tags full of lorem ipsum text",
+  "version": "0.5.1",
+  "description": "A component for React that renders paragraph or list item tags full of lorem ipsum text",
   "main": "index.js",
@@ -30,2 +30,5 @@ "repository": {
   },
+  "peerDependencies": {
+    "react": "~0.8.0"
+  },
   "devDependencies": {
@@ -35,7 +38,10 @@ "semver": "~2.2.1",
     "jshint": "~2.4.3",
-    "mocha": "~1.17.1"
-  },
-  "peerDependencies": {
+    "mocha": "~1.17.1",
+    "connect-browserify": "~1.0.0",
+    "express": "~3.4.8",
+    "node-jsx": "~0.2.1",
+    "reactify": "~0.7.0",
+    "envify": "~0.2.0",
     "react": "~0.8.0"
   }
 }

README.md

 # React Lorem Component
 
-A component for React that renders paragraph tags full of lorem ipsum text.
+A component for [React][1] that renders paragraph or list item tags full 
+of lorem ipsum text.
 
+
 ## Installation
@@ -11,8 +13,40 @@
 
+
 ## Usage
 
-TODO
+Library provides a component named `Lorem` which renderes 
+pseudo-random lorem ipsum text.
 
+    var React = require('react');
+    var Lorem = require('react-lorem-component');
+
+    var MyComponent = React.createClass({
+      render: function() {
+        return (
+          <div>
+            <h1>Lorem Ipsum</h1>
+            <Lorem />
+          </div>
+        );
+      }
+    });
+
+The above `<Lorem />` tag by default renders five paragraphs 
+of lorem wrapped in a `<div>`.
+
+TODO: explain config props
+
+
 ## Example
 
-TODO
+The examples code is located at `example` directory. You can clone this
+repository and run `make install example` and point your web browser to
+`http://localhost:3000`.
+
+
+## Licence
+
+MIT
+
+
+[1]: https://facebook.github.io/react/

spec.js

@@ -6,3 +6,3 @@ var assert      = require('assert');
 describe('react-lorem-component', function() {
-  it('transfers properties', function() {
+  it('transfers props', function() {
     React.renderComponentToString(LoremIpsum({ className: "lorem-ipsum" }), function(markup) {
@@ -9,0 +9,0 @@ assert(/^<div [^>]*?class="lorem-ipsum"/.test(markup));

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

8281

increased by33.74%

Number of package files

10

increased by25%

Lines of code

118

increased by53.25%

Number of lines in readme file

52

increased by188.89%

Worsened metrics

Dev dependency count

10

increased by150%

No dependency changes