react-jazzicon - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "react-jazzicon",
-  "version": "0.0.0",
-  "description": "React component for flyswatter/jazzicon",
+  "version": "0.0.1",
+  "description": "React component for danfinlay/jazzicon",
   "main": "lib/index.js",
@@ -11,2 +11,9 @@ "scripts": {
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marcusmolchany/react-jazzicon.git"
+  },
+  "bugs": {
+    "url": "https://github.com/marcusmolchany/react-jazzicon/issues"
+  },
   "keywords": [
@@ -18,3 +25,3 @@ "jazzicon",
   ],
-  "author": "",
+  "author": "marcusmolchany",
   "license": "MIT",
@@ -21,0 +28,0 @@ "dependencies": {

README.md

 react-jazzicon
 ==============
+[![NPM version][npm-image]][npm-url] [![dependencies Status][david-dep-image]][david-dep-url] [![devDependencies Status][david-devDep-image]][david-devDep-url]
 
-# demo page
+This is a react component for [Dan Finlay's](https://github.com/danfinlay)
+[jazzicon](https://github.com/danfinlay/jazzicon).
 
+# usage
+
+```js
+import Jazzicon from 'react-jazzicon'
+
+export default class App extends React.Component {
+
+  …
+
+  render() {
+    return (
+      <Jazzicon diameter={100} seed={Math.random(100).toString()} />
+    )
+  }
+}
+```
+
+# setup
+
+```sh
+$ https://github.com/marcusmolchany/react-jazzicon
+$ cd react-jazzicon
+$ yarn # or npm i
+```
+
+## demo page
+
 the demo page is on the `gh-pages` branch in the `demo` folder.
@@ -10,8 +39,15 @@
 # first install dependencies in the top level package
-$ npm i # or yarn
+$ yarn # or npm i
 
 # then checkout the gh-pages branch and install dependencies in the "demo" folder
 $ git checkout gh-pages
-$ cd demo && npm i # or yarn
-$ npm run start # or yarn start
+$ cd demo && yarn # or npm i
+$ yarn start # or npm run start
 ```
+
+[david-dep-image]: https://david-dm.org/marcusmolchany/react-jazzicon/status.svg
+[david-dep-url]: https://david-dm.org/marcusmolchany/react-jazzicon
+[david-devDep-image]: https://david-dm.org/marcusmolchany/react-jazzicon/dev-status.svg
+[david-devDep-url]: https://david-dm.org/marcusmolchany/react-jazzicon?type=dev
+[npm-image]: https://badge.fury.io/js/react-jazzicon.svg
+[npm-url]: https://npmjs.org/package/react-jazzicon

Fixed alerts

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

94340

increased by1.35%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

53

increased by211.76%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes