x-react-flipclock - npm Package Compare versions

Comparing version 0.1.18415 to 0.1.184152

package.json

 {
   "name": "x-react-flipclock",
   "description": "Simple NPM package for React to display Flip Clock",
-  "version": "0.1.18415",
+  "version": "0.1.184152",
   "author": "Maxim Shklyar (kisla interactive)",
   "license": "MIT",
-  "homepage": "https://github.com/xims/react-flipclock",
+  "homepage": "https://github.com/xims/x-react-flipclock",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/xims/react-flipclock.git"
+    "url": "git+https://github.com/xims/x-react-flipclock.git"
   },
-  "main": "dist/FlipClock.js",
+  "main": "lib/FlipClock.js",
   "scripts": {
@@ -17,8 +17,6 @@ "start": "webpack-dev-server --mode=development --inline --hot --history-api-fallback --host localhost --port 9020 --progress --colors",
     "lint-fix": "eslint src --fix",
-    "bpc": "npm run build-prod && npm run copy-prod",
-    "bpcv": "npm run build-prod && npm run copy-prod && npm --no-git-tag-version version patch",
-    "build-prod": "cross-env --mode=production BABEL_ENV=production webpack -p --env=production --progress --colors --display-error-details",
-    "build-dist": "cross-env --mode=production BABEL_ENV=production webpack -p --env=production --progress --colors --display-error-details --config webpack.dist.config.js",
-    "build-dev": "webpack",
-    "build-dev-examples": "webpack --config webpack.examples.config.js"
+    "bpcv": "npm run build-prod && npm --no-git-tag-version version patch",
+    "build-docs": "cross-env --mode=production BABEL_ENV=production webpack -p --env=production --progress --colors --display-error-details",
+    "build-lib": "cross-env --mode=production BABEL_ENV=production webpack -p --env=production --progress --colors --display-error-details --config webpack.lib.config.js",
+    "build-dev": "webpack"
   },
@@ -63,5 +61,6 @@ "dependencies": {
   "bugs": {
-    "url": "https://github.com/xims/react-flipclock/issues"
+    "url": "https://github.com/xims/x-react-flipclock/issues"
   },
   "directories": {
+    "lib": "lib",
     "example": "examples"
@@ -68,0 +67,0 @@ },

README.md

@@ -1,5 +0,121 @@
-# react-flipclock
-Simple NPM package for React to display Flip Clock
+# x-react-flipclock
 
+Simple NPM package for React to display Flip Clock.
+Examples are at https://xims.github.io/x-react-flipclock
+Source repository at https://github.com/xims/x-react-flipclock
+NPM package page at https://www.npmjs.com/package/x-react-flipclock
 
-Initial code based on https://codepen.io/Libor_G/pen/JyJzjb
+
+## Installation
+
+`npm install x-react-flipclock`
+
+
+## Usage
+
+Initiate:
+```js
+
+import FlipClock from 'x-react-flipclock'
+
+```
+
+There are 2 types of display - Clock and Countdown 
+
+To use as a clock - 
+```js
+
+<FlipClock
+	type="clock"
+ />
+
+```
+
+
+To use as a clock - 
+```js
+
+<FlipClock
+	type="clock"
+ />
+
+```
+
+
+To use as a countdown - 
+```js
+
+<FlipClock 
+	type = "countdown"
+	count_to = "2019-01-01 00:00:00"
+ />
+
+```
+
+
+### Options
+
+Specify and configure units to display - 
+```js
+
+<FlipClock 
+	type = "clock"
+	units = {[
+				{
+					sep: '',
+					type: 'days',
+					title: 'day',
+				},
+				{
+					sep: '/',
+					type: 'months',
+					title: 'month',
+				},
+				{
+					sep: '/',
+					type: 'years',
+					title: 'year',
+				},
+				{
+					sep: ' ',
+					type: 'hours',
+					title: 'hour',
+				},
+				{
+					sep: ':',
+					type: 'minutes',
+					title: 'minute',
+				},
+				{
+					sep: ':',
+					type: 'seconds',
+					title: 'second',
+				}
+			]}
+ />
+
+```
+
+
+## Development
+
+This package functionality is very basic and may be extended in the future.
+Would be great to develop the package to adapt unit sizes to container area.
+Also would be great to have styles options.
+
+
+## Contributions
+
+Contributions are welcome!
+
+
+## Acknowledgement
+
+Initial code based on https://codepen.io/Libor_G/pen/JyJzjb
+
+
+## License
+
+Copyright (c) 2018 Maxim Shklyar, kisla interactive
+
+Licensed under the MIT License.

webpack.config.js

@@ -15,3 +15,3 @@ const webpack = require('webpack')
 	entry: {
-		'app': [
+		'FlipClockExamples': [
 			'babel-polyfill',
@@ -28,3 +28,3 @@
 		// path: path.resolve(__dirname, './www/build'),
-		path: __dirname + '/www',
+		path: __dirname + '/docs',
 		// publicPath: 'build/',
@@ -134,3 +134,3 @@ filename: 'FlipClockExamples.js',
 
-		contentBase: __dirname + '/www',
+		contentBase: __dirname + '/docs',
 
@@ -153,3 +153,3 @@ hot: true
 			new CleanWebpackPlugin(['build/*'], {
-				root: __dirname + '/www',
+				root: __dirname + '/docs',
 				verbose: true,
@@ -194,3 +194,3 @@ dry: false, // true for simulation
 			new CleanWebpackPlugin(['build/*'], {
-				root: __dirname + '/www',
+				root: __dirname + '/docs',
 				verbose: true,
@@ -197,0 +197,0 @@ dry: false, // true for simulation

No alert changes

Improved metrics

Number of lines in readme file

121

increased by2320%

Worsened metrics

Total package byte prevSize

45625

decreased by-4.9%

Number of package files

9

decreased by-40%

Lines of code

543

decreased by-19.67%

No dependency changes