react-fontawesome - npm Package Compare versions

Comparing version 0.3.2 to 0.3.3

lib/index.js

@@ -99,2 +99,2 @@ 'use strict';
 });
-module.exports = exports['default'];
+module.exports = exports['default'];

package.json

 {
   "name": "react-fontawesome",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "A React component for the font-awesome icon library.",
@@ -10,3 +10,5 @@ "repository": {
   "config": {
-    "entry": "src/index.js"
+    "entry": "src",
+    "output": "lib",
+    "mainFile": "src/index.js"
   },
@@ -18,5 +20,5 @@ "bugs": {
   "scripts": {
-    "build": "babel -o $npm_package_main $npm_package_config_entry",
+    "build": "babel $npm_package_config_entry --out-dir $npm_package_config_output",
     "dist": "npm run lint && npm run build && npm test && npm run docs",
-    "docs": "jsdoc2md $npm_package_config_entry > api.md",
+    "docs": "jsdoc2md $npm_package_config_mainFile > api.md",
     "lint": "eslint .",
@@ -23,0 +25,0 @@ "prepublish": "npm run dist",

readme.md

@@ -10,11 +10,3 @@ # react-fontawesome
 
-- Simple API that mirrors Font Awesome's classes.
-- Supports all Font Awesome modifiers (see [API](#API) below).
-- Add your own `className`s, styles and other props (all additional props are passed directly to the component).
-- Standard, non-ES6 JavaScript, so should work most places without a build step.
-    - Packaged as a CommonJS/npm module.
-    - Doesn't use JSX so no transforms needed.
-    - Does not require a specific build process/tool other than something that supports npm.
 
-
 ## Install
@@ -29,4 +21,2 @@
 
-Basic usage:
-
 ```js
@@ -36,7 +26,18 @@ var React = require('react');
 
-React.render(<FontAwesome name='person' />, document.body);
+React.render(<FontAwesome name='rocket' />, document.body);
 ```
 
-Advanced usage:
 
+## Features
+
+- No dependencies (other than React)
+- Simple API that mirrors Font Awesome's class names.
+- Supports all Font Awesome modifiers (see [API](#API) below).
+- Add your own `className`s, styles and other props (all additional props are passed directly to the component).
+
+*Note: This component does not include any of the Font Awesome CSS or fonts, so you'll need to make sure to include those on your end somehow, either by adding them to your build process or linking to CDN versions.*
+
+
+## Examples
+
 ```js
@@ -61,5 +62,3 @@ var React = require('react');
 
-This component does not include any of the Font Awesome CSS or fonts, so you'll need to make sure to include those on your end somehow, either by adding them to your build process or linking to the CDN versions.
 
-
 ## API
@@ -76,3 +75,3 @@
 
-Run the test suite with `npm test`, make sure tests are passing and that you write tests for new features.
+Run the test suite with `npm test` and linting with `npm run lint`. Make sure tests are passing and that you write tests for new features and document changes to the API with updates to the JSDocs.
 
@@ -79,0 +78,0 @@

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

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

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

9110

decreased by-40.92%

Number of package files

8

decreased by-50%

Lines of code

84

decreased by-36.36%

Number of lines in readme file

80

decreased by-1.23%

No dependency changes