chore(example, doc): adding example and doc

README.md

@@ -16,15 +16,15 @@ or
 yarn add business-hours.js
 ```
 
-# Usage
-
 # Configuration
 
 To get started, setup a JSON file where you define the business hours.
+
 `0` stands for `Sunday`
-`1` stands for `Monday`
-and so on.
-You can have 1 to N `from/to` pairs per weekday.
+
+`1` stands for `Monday` and so on.
+
+You can have 1 to N `from/to` pairs per weekday. If on a given day you are closed, instead of a `from/to` pair, just put `closed`.
 
 ```json
 {
@@ -96,5 +96,21 @@ You can have 1 to N `from/to` pairs per weekday.
 }
 ```
 
+# Usage
+
+First import the lib
+```
+import businessHours from "business-hours.js";
+```
+Then you have to initalize the lib with your business hours
+```
+businessHours.init(hoursJson);
+```
+`hoursJson` must be in JSON format. It could come from an external file
+```
+import hoursJson from "./hours.json";
+```
+or it could come from any other endpoind, as long as it's JSON.
+
 # Example
-coming soon
+Find an whole example in React here [here](example/)

dist/index.js

@@ -2,10 +2,6 @@
 
 var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
 
-var _hours = require("./hours.json");
-
-var _hours2 = _interopRequireDefault(_hours);
-
 var _set_minutes = require("date-fns/set_minutes");
 
 var _set_minutes2 = _interopRequireDefault(_set_minutes);
@@ -42,6 +38,10 @@ var _is_before = require("date-fns/is_before");
 
 var _is_before2 = _interopRequireDefault(_is_before);
 
+var _lodash = require("lodash");
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
@@ -71,9 +71,10 @@ var BusinessHours = function () {
     value: function init(hours) {
       var _this = this;
 
-      if (hours === undefined) {
-        hours = _hours2.default;
+      if (_lodash2.default.isEmpty(hours)) {
+        throw new Error("Hours are not set. Check your init() function.");
       }
+
       weekdays.forEach(function (day, index) {
         if (!hours.hasOwnProperty(index.toString())) {
           throw new Error(day + " is missing from config");
@@ -84,9 +85,9 @@ var BusinessHours = function () {
             } else if (!hours[index.toString()][0].hasOwnProperty("to")) {
               console.error(day + " is missing 'to' in config");
             } else if (!_this._isHourValid(hours[index.toString()][0].from)) {
-              console.error(day + "'s 'from1' has not the right format. Should be ##:##");
+              console.error(day + "'s 'from' has not the right format. Should be ##:##");
             } else if (!_this._isHourValid(hours[index.toString()][0].to)) {
-              console.error(day + "'s 'to1' has not the right format. Should be ##:##");
+              console.error(day + "'s 'to' has not the right format. Should be ##:##");
             }
           }
         }

example/.gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/ignore-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

example/README.md

@@ -0,0 +1,5 @@
+## Run
+
+To run this example:
+
+```npm start```

example/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "example",
+  "version": "0.0.1",
+  "private": true,
+  "devDependencies": {
+    "react-scripts": "1.0.17"
+  },
+  "dependencies": {
+    "business-hours.js": "1.0.3",
+    "react": "16.1.0",
+    "react-dom": "16.1.0"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test --env=jsdom",
+    "eject": "react-scripts eject"
+  }
+}

example/public/index.html

@@ -0,0 +1,40 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <!--
+      manifest.json provides metadata used when your web app is added to the
+      homescreen on Android. See https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json">
+    <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>
+      You need to enable JavaScript to run this app.
+    </noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

example/public/manifest.json

@@ -0,0 +1,15 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "192x192",
+      "type": "image/png"
+    }
+  ],
+  "start_url": "./index.html",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}

example/src/App.css

@@ -0,0 +1,28 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  animation: App-logo-spin infinite 20s linear;
+  height: 80px;
+}
+
+.App-header {
+  background-color: #222;
+  height: 150px;
+  padding: 20px;
+  color: white;
+}
+
+.App-title {
+  font-size: 1.5em;
+}
+
+.App-intro {
+  font-size: large;
+}
+
+@keyframes App-logo-spin {
+  from { transform: rotate(0deg); }
+  to { transform: rotate(360deg); }
+}

example/src/App.js

@@ -0,0 +1,50 @@
+import React, { Component } from "react";
+import hoursJson from "./hours.json";
+import businessHours from "business-hours.js";
+import "./App.css";
+
+class App extends Component {
+  componentWillMount() {
+    businessHours.init(hoursJson);
+  }
+
+  render() {
+    return (
+      <div className="App">
+        <header className="App-header">
+          <p className="App-intro">
+            Is open now? {businessHours.isOpenNow().toString()}
+          </p>
+          <p>Next opening hour: {businessHours.nextOpeningHour().toString()}</p>
+          <p>
+            Is it open tomorrow? {businessHours.isOpenTomorrow().toString()}
+          </p>
+        </header>
+        <h1>business-hours.js Example</h1>
+        <p>
+          Sunday: <br />10:00-13:30 and 17:00-20:00 and 21:00-24:00
+        </p>
+        <p>
+          Monday: <br />10:00-13:30 and 18:00-22:00
+        </p>
+        <p>
+          Thuesday: <br />CLOSED
+        </p>
+        <p>
+          Wednesday: <br />10:00-13:30 and 18:00-22:00
+        </p>
+        <p>
+          Thursday: <br />10:00-13:30 and 18:00-22:00
+        </p>
+        <p>
+          Friday: <br />10:00-13:30 and 18:00-22:00
+        </p>
+        <p>
+          Satuday: <br />10:00-13:30 and 18:00-22:00
+        </p>
+      </div>
+    );
+  }
+}
+
+export default App;

example/src/App.test.js

@@ -0,0 +1,8 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import App from './App';
+
+it('renders without crashing', () => {
+  const div = document.createElement('div');
+  ReactDOM.render(<App />, div);
+});

example/src/index.css

@@ -0,0 +1,5 @@
+body {
+  margin: 0;
+  padding: 0;
+  font-family: sans-serif;
+}

example/src/index.js

@@ -0,0 +1,8 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import './index.css';
+import App from './App';
+import registerServiceWorker from './registerServiceWorker';
+
+ReactDOM.render(<App />, document.getElementById('root'));
+registerServiceWorker();