react-live-clock - npm Package Compare versions

Comparing version 0.0.5 to 1.0.0

package.json

 {
   "name": "react-live-clock",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "description": "React Live Clock",
-  "main": "build/react-live-clock.js",
-  "bin": {
-    "react-live-clock": "cli.js"
-  },
+  "main": "lib/index.js",
   "config": {
@@ -13,7 +10,9 @@ "component": "ReactLiveClock"
   "scripts": {
-    "start": "p-s",
+    "start": "react-component-template",
     "test": "npm start test",
+    "template": "cf-react-component-template",
     "precommit": "npm start precommit",
     "prepush": "npm start prepush",
-    "postversion": "npm start postversion"
+    "postversion": "npm start postversion",
+    "prepublish": "npm start prepublish"
   },
@@ -25,8 +24,5 @@ "repository": {
   "keywords": [
-    "clock",
-    "date",
-    "moment",
-    "react",
-    "time",
-    "timezones"
+    "component",
+    "react-component",
+    "react"
   ],
@@ -39,52 +35,15 @@ "author": "Pavlo Vozniuk <[e-mail]>",
   "homepage": "https://github.com/pvoznyuk/react-live-clock",
+  "peerDependencies": {
+    "react": "^0.14 || ^15"
+  },
   "devDependencies": {
-    "babel-cli": "6.24.1",
-    "babel-core": "6.24.1",
-    "babel-eslint": "7.2.3",
-    "babel-istanbul": "0.12.2",
-    "babel-loader": "7.0.0",
-    "babel-plugin-transform-class-properties": "6.24.1",
-    "babel-plugin-transform-object-rest-spread": "6.23.0",
-    "babel-plugin-transform-react-remove-prop-types": "0.4.1",
-    "babel-preset-es2015": "6.24.1",
-    "babel-preset-react": "6.24.1",
-    "codecov": "2.1.0",
-    "cross-env": "4.0.0",
-    "css-loader": "0.28.0",
-    "css-modules-require-hook": "4.0.6",
-    "eslint": "3.19.0",
-    "eslint-plugin-react": "6.10.3",
-    "gh-pages": "0.12.0",
-    "glob": "7.1.1",
-    "html-webpack-plugin": "2.28.0",
-    "husky": "0.13.3",
-    "nightwatch-autorun": "3.1.0",
-    "p-s": "3.1.0",
-    "react": "15.5.4",
-    "react-dom": "15.5.4",
-    "rimraf": "2.6.1",
-    "sinon": "2.1.0",
-    "style-loader": "0.16.1",
-    "tap-nyan": "1.1.0",
-    "tap-xunit": "1.7.0",
-    "tape": "4.6.3",
-    "webpack": "2.4.1",
-    "webpack-dev-server": "2.4.4"
+    "react-component-template": "0.1.8",
+    "cf-react-component-template": "0.1.8"
   },
-  "files": [
-    "/test/index.js",
-    "/test-e2e/Smoketest.js",
-    "/.eslintrc",
-    "/cli.js",
-    "/nightwatch.json",
-    "/package-scripts.js",
-    "/README.md",
-    "/webpack.config.js"
-  ],
   "dependencies": {
+    "prop-types": "15.5.10",
+    "react-moment": "0.2.2",
     "moment": "2.18.1",
-    "moment-timezone": "0.5.13",
-    "prop-types": "15.5.10",
-    "react-moment": "0.2.2"
+    "moment-timezone": "0.5.13"
   }
 }

README.md

@@ -1,16 +0,40 @@
-# react-live-clock
-React clock with time-zones  
+# react-live-clock [![npm](https://img.shields.io/npm/v/react-live-clock.svg?style=flat-square)](https://www.npmjs.com/package/react-live-clock)
+
+[![Gitter](https://img.shields.io/gitter/room/pvoznyuk/help.svg?style=flat-square)](https://gitter.im/pvoznyuk/help)
+
+[![CircleCI](https://img.shields.io/circleci/project/pvoznyuk/react-live-clock.svg?style=flat-square&label=nix-build)](https://circleci.com/gh/pvoznyuk/react-live-clock)
+[![AppVeyor](https://img.shields.io/appveyor/ci/pvoznyuk/react-live-clock.svg?style=flat-square&label=win-build)](https://ci.appveyor.com/project/pvoznyuk/react-live-clock)
+[![Coverage](https://img.shields.io/codecov/c/github/pvoznyuk/react-live-clock.svg?style=flat-square)](https://codecov.io/github/pvoznyuk/react-live-clock?branch=master)
+[![Dependencies](https://img.shields.io/david/pvoznyuk/react-live-clock.svg?style=flat-square)](https://david-dm.org/pvoznyuk/react-live-clock)
+[![Dev Dependencies](https://img.shields.io/david/dev/pvoznyuk/react-live-clock.svg?style=flat-square)](https://david-dm.org/pvoznyuk/react-live-clock#info=devDependencies)
+
+React clock with time-zones
 [DEMO](https://pvoznyuk.github.io/react-live-clock/)
 
-### Installing
-Use npm to install react-react-live-clock
+## Installation
 
+### NPM
 ```sh
-npm install --save react-live-clock
+npm install --save react react-live-clock
 ```
 
+Don't forget to manually install peer dependencies (`react`) if you use npm@3.
 
-### Quick Start
+### Bower:
+```sh
+bower install --save https://unpkg.com/react-live-clock/bower.zip
+```
 
+## Demo
+
+[http://pvoznyuk.github.io/react-live-clock](http://pvoznyuk.github.io/react-live-clock)
+
+## Codepen demo
+
 ```js
+// TODO
+```
+
+## Usage
+```js
 import React  from 'react';
@@ -35,24 +59,54 @@ import Clock from 'react-live-clock';
 
-### Formatting
+ ### Formatting
 
-```js
-import React  from 'react';
-import Clock from 'react-live-clock';
+ ```js
+ import React  from 'react';
+ import Clock from 'react-live-clock';
 
-exports default class MyComponent extends React.Component {
-    render() {
-        <Clock format="YYYY/MM/DD">1976-04-19T12:59-0500</Clock>
-    }
-}
-```
+ exports default class MyComponent extends React.Component {
+     render() {
+         <Clock format="YYYY/MM/DD">1976-04-19T12:59-0500</Clock>
+     }
+ }
+ ```
 
-Outputs:
+ Outputs:
 
-```html
-<time>1976/04/19</time>
+ ```html
+ <time>1976/04/19</time>
+ ```
+
+ ** you can use any formatting from [moment](http://momentjs.com/) date library
+
+
+
+## Development and testing
+
+Currently is being developed and tested with the latest stable `Node 7` on `OSX` and `Windows`.
+
+To run example covering all `ReactLiveClock` features, use `npm start dev`, which will compile `src/example/Example.js`
+
+```bash
+git clone [e-mail]:pvoznyuk/react-live-clock.git
+cd react-live-clock
+npm install
+npm start dev
+
+# then
+open http://localhost:8080
 ```
 
-** you can use any formatting from [moment](http://momentjs.com/) date library
+## Tests
 
+```bash
+# to run tests
+npm start test
 
+# to generate test coverage (./reports/coverage)
+npm start test.cov
+
+# to run end-to-end tests
+npm start test.e2e
+```
+
 ### License
@@ -59,0 +113,0 @@ This software is released under the MIT license. See LICENSE for more details.

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

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

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

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

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 4 instances 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

7121523

increased by20633.44%

Dev dependency count

2

decreased by-93.75%

Number of package files

25

increased by150%

Lines of code

52205

increased by23737.9%

Number of lines in readme file

117

increased by85.71%

Worsened metrics

Dependency count

5

increased by25%

Number of low supply chain risk alerts

47

increased by422.22%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes