react-nice-avatar - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

dist/react-nice-avatar.d.ts

@@ -16,2 +16,3 @@ import * as React from 'react';
   eyeStyle?: 'circle' | 'oval' | 'smile',
+  glassesStyle?: 'round' | 'square' | 'none',
   noseStyle?: 'short' | 'long' | 'round',
@@ -18,0 +19,0 @@ mouthStyle?: 'laugh' | 'smile' | 'peace',

package.json

 {
   "name": "react-nice-avatar",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Beautiful default avatar for your users",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

react-nice-avatar.d.ts

@@ -16,2 +16,3 @@ import * as React from 'react';
   eyeStyle?: 'circle' | 'oval' | 'smile',
+  glassesStyle?: 'round' | 'square' | 'none',
   noseStyle?: 'short' | 'long' | 'round',
@@ -18,0 +19,0 @@ mouthStyle?: 'laugh' | 'smile' | 'peace',

README.md

@@ -41,6 +41,6 @@ # react-nice-avatar
 ```js
-const myConfig = genConfig(AvatarConfig?)
+const config = genConfig(AvatarConfig?)
 ```
 
-3. Render the component with config and width / height
+3. Render the component with specific width / height and configuration
 
@@ -50,7 +50,5 @@
 <Avatar style={{ width: '8rem', height: '8rem' }} {...config} />
-```
 
-or using className to set the width / height
+or
 
-```js
 <Avatar className="w-32 h-32" {...config} />
@@ -61,10 +59,10 @@ ```
 
-The options can be passed into genConfig or on React props
+The options can be passed into genConfig or as React props
 
-|key|type|default|accept
-|---|---|---|---|
-|id|string|
-|className|string|
-|style|object|
-|shape|string|circle|circle, rounded, square
+|key|type|default|accept|tips
+|---|---|---|---|---|
+|id|string| | | Only for React Props
+|className|string| | | Only for React Props
+|style|object| | | Only for React Props
+|shape|string|circle|circle, rounded, square| Only for React Props
 |sex| string | | man, woman
@@ -76,2 +74,3 @@ |faceColor| string |
 |eyeStyle| string | | circle, oval, smile
+|glassesStyle| string | | none, round, square | Usually is none
 |noseStyle| string | | short, long, round
@@ -83,3 +82,3 @@ |mouthStyle| string | | laugh, smile, peace
 
-## Develop in the local
+## Development
 
@@ -86,0 +85,0 @@ 1. `$ git clone [e-mail]:chilllab/react-nice-avatar.git`: Clone the codebase

No alert changes

Improved metrics

Total package byte prevSize

163323

increased by2.82%

Lines of code

3980

increased by3.32%

Worsened metrics

Number of lines in readme file

89

decreased by-1.11%

No dependency changes