@zendeskgarden/react-avatars - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0-beta.88e1c2ba

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+<a name="2.1.0-beta.88e1c2ba"></a>
+# [2.1.0-beta.88e1c2ba](https://github.com/zendeskgarden/react-components/compare/@zendeskgarden/react-avatars@2.0.1...@zendeskgarden/react-avatars@2.1.0-beta.88e1c2ba) (2018-05-22)
+
+
+
+
+**Note:** Version bump only for package @zendeskgarden/react-avatars
+
 <a name="2.0.1"></a>
@@ -8,0 +16,0 @@ ## [2.0.1](https://github.com/zendeskgarden/react-components/compare/@zendeskgarden/react-avatars@2.0.0...@zendeskgarden/react-avatars@2.0.1) (2018-05-15)

package.json

@@ -11,4 +11,7 @@ {
   },
-  "version": "2.0.1",
-  "main": "./index.js",
+  "version": "2.1.0-beta.88e1c2ba",
+  "main": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
   "scripts": {
@@ -20,11 +23,14 @@ "build": "../../utils/scripts/build.sh",
   "dependencies": {
-    "@zendeskgarden/css-avatars": "^3.0.0",
+    "classnames": "^2.2.5"
+  },
+  "peerDependencies": {
     "@zendeskgarden/react-theming": "^1.0.0",
-    "classnames": "^2.2.5",
     "prop-types": "^15.6.1",
+    "react": "^0.14.0 || ^15.0.0 || ^16.0.0",
+    "react-dom": "^0.14.0 || ^15.0.0 || ^16.0.0",
     "styled-components": "^3.2.6"
   },
-  "peerDependencies": {
-    "react": "^0.14.0 || ^15.0.0 || ^16.0.0",
-    "react-dom": "^0.14.0 || ^15.0.0 || ^16.0.0"
+  "devDependencies": {
+    "@zendeskgarden/css-avatars": "^3.0.0",
+    "@zendeskgarden/react-theming": "^1.1.0-beta.88e1c2ba"
   },
@@ -39,3 +45,5 @@ "keywords": [
     "access": "public"
-  }
+  },
+  "zendeskgarden:library": "GardenAvatars",
+  "zendeskgarden:src": "src/index.js"
 }

README.md

@@ -12,2 +12,5 @@ # @zendeskgarden/react-avatars [![npm version](https://img.shields.io/npm/v/@zendeskgarden/react-avatars.svg?style=flat-square)](https://www.npmjs.com/package/@zendeskgarden/react-avatars) [![Dependency Status](https://img.shields.io/david/zendeskgarden/react-components.svg?path=packages/avatars&style=flat-square)](https://david-dm.org/zendeskgarden/react-components?path=packages/avatars) <!-- markdownlint-disable -->
 npm install @zendeskgarden/react-avatars
+
+# Peer Dependencies - Also Required
+npm install react react-dom prop-types styled-components @zendeskgarden/react-theming
 ```
@@ -18,7 +21,18 @@
 ```jsx static
-import Avatar from '@zendeskgarden/react-avatars/Avatar';
+/**
+ * Include avatar styling at the root of your application
+ */
+import '@zendeskgarden/react-avatars/dist/styles.css';
 
-<Avatar>
-  <img src="images/amir.png" alt="Example Avatar" />
-</Avatar>;
+import { ThemeProvider } from '@zendeskgarden/react-theming';
+import { Avatar } from '@zendeskgarden/react-avatars';
+
+/**
+ * Place a `ThemeProvider` at the root of your React application
+ */
+<ThemeProvider>
+  <Avatar>
+    <img src="images/amir.png" alt="Example Avatar" />
+  </Avatar>
+</ThemeProvider>;
 ```

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

37712

increased by103.91%

Dependency count

6

decreased by-14.29%

Number of package files

9

increased by50%

Lines of code

211

increased by185.14%

Number of lines in readme file

37

increased by60.87%

Worsened metrics

Dev dependency count

2

increased byInfinity%

Number of low quality alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• - Removed@zendeskgarden/css-avatars@^3.0.0

• - Removed@zendeskgarden/react-theming@^1.0.0

• - Removedprop-types@^15.6.1

• - Removedstyled-components@^3.2.6

• - Removed@zendeskgarden/css-avatars@3.0.11(transitive)

• - Removed@zendeskgarden/css-variables@5.2.4(transitive)