feature/update documentation (#74)

* update readme.md

* update readme.md (add emoji)

* WIP: update demo page

* WIP: add emoji on demo page

* WIP: update version

* WIP: add code qualify badegs

* WIP: add ci setting for codeclimate coverage test

.codeclimate.yml

@@ -0,0 +1,6 @@
+exclude_patterns:
+- src/**/*.spec.ts
+- dist/**/*
+- demo/**/*
+- docs/**/*
+- examples/**/*

.editorconfig

@@ -1,6 +1,13 @@
+#root = true
+
 [*]
 indent_style = space
 end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+indent_size = 4
 
-[*.js]
-indent_size = 2
+[*.md]
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1,2 @@
+dist/**/*.js
+build/**/*.js

.gitattributes

@@ -0,0 +1,5 @@
+dist/* linguist-vendored=true
+docs/* linguist-vendored=true
+demo/* linguist-vendored=true
+*.html linguist-vendored=true
+*.css linguist-vendored=true

.gitignore

@@ -1,7 +1,6 @@
-node_modules/
-.idea/
 .nyc_output/
-*.DS_Store
-build
+.rpt2_cache/
+.idea/
+node_modules/
 coverage/
-package-lock.json
+src/**/*.js

.travis.yml

@@ -15,4 +15,5 @@ script:
   - npm test
 after_success:
   - npm run coverage
-  - npm run clean
+  - npm run clean
+  - CODECLIMATE_REPO_TOKEN=191371dd88a596d5362fd89c93fd5de9ab71205a6c7291e3fbdffed2ce7621ef codeclimate-test-reporter < ./coverage/lcov.info

README.md

@@ -1,16 +1,31 @@
-# PIGNOSE Calendar
+<h1 align="center">PIGNOSE Calendar :date:</h1>
 
-Beautiful and eidetic jQuery date picker plugin.
+<p align="center">Beautiful and eidetic jQuery date picker plugin</p>
 
-[![Build Status](https://travis-ci.org/KennethanCeyer/pg-calendar.svg?branch=master)](https://travis-ci.org/KennethanCeyer/pg-calendar) [![Coverage Status](https://coveralls.io/repos/github/KennethanCeyer/pg-calendar/badge.svg?branch=master)](https://coveralls.io/github/KennethanCeyer/pg-calendar?branch=master) [![codecov](https://codecov.io/gh/KennethanCeyer/pg-calendar/branch/master/graph/badge.svg)](https://codecov.io/gh/KennethanCeyer/pg-calendar)
+<p align="center"><a href="https://nodei.co/npm/pg-calendar/"><img src="https://nodei.co/npm/pg-calendar.png" alt="NPM"></a></p>
 
-[![npm version](https://badge.fury.io/js/pg-calendar.svg)](https://badge.fury.io/js/pg-calendar) [![npm downloads](https://img.shields.io/npm/dm/pg-calendar.svg?maxAge=2592000)](https://www.npmjs.com/package/pg-calendar) [![Bower version](https://badge.fury.io/bo/pg-calendar.svg)](https://badge.fury.io/bo/pg-calendar) [![GitHub license](https://img.shields.io/github/license/KennethanCeyer/pg-calendar.svg)](https://github.com/KennethanCeyer/pg-calendar/blob/master/LICENSE) [![Join the chat at https://gitter.im/KennethanCeyer/PIGNOSE](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/KennethanCeyer/PIGNOSE?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+<p align="center">
+  <a href="https://travis-ci.org/KennethanCeyer/pg-calendar"><img src="https://travis-ci.org/KennethanCeyer/pg-calendar.svg?branch=master" alt="Build Status"></a>
+  <a href="https://coveralls.io/github/KennethanCeyer/pg-calendar?branch=master"><img src="https://coveralls.io/repos/github/KennethanCeyer/pg-calendar/badge.svg?branch=master" alt="Coverage Status"></a>
+  <a href="https://codecov.io/gh/KennethanCeyer/pg-calendar"><img src="https://codecov.io/gh/KennethanCeyer/pg-calendar/branch/master/graph/badge.svg" alt="codecov"></a>
+</p>
 
-[![dependencies Status](https://david-dm.org/kennethanceyer/pg-calendar/status.svg)](https://david-dm.org/kennethanceyer/pg-calendar) [![devDependencies Status](https://david-dm.org/kennethanceyer/pg-calendar/dev-status.svg)](https://david-dm.org/kennethanceyer/pg-calendar?type=dev)
+<p align="center">
+  <a href="https://badge.fury.io/js/pg-calendar"><img src="https://badge.fury.io/js/pg-calendar.svg" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/pg-calendar"><img src="https://img.shields.io/npm/dm/pg-calendar.svg?maxAge=2592000" alt="npm downloads"></a>
+  <a href="https://github.com/KennethanCeyer/pg-calendar/blob/master/LICENSE"><img src="https://img.shields.io/github/license/KennethanCeyer/pg-calendar.svg" alt="GitHub license"></a>
+  <a href="https://gitter.im/KennethanCeyer/PIGNOSE?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/KennethanCeyer/PIGNOSE"></a>
+</p>
 
-----
+<p align="center">
+  <a href="https://www.codefactor.io/repository/github/kennethanceyer/pg-calendar"><img src="https://www.codefactor.io/repository/github/kennethanceyer/pg-calendar/badge" /></a>
+  <a href="https://codeclimate.com/github/KennethanCeyer/pg-calendar/maintainability"><img src="https://api.codeclimate.com/v1/badges/e46890fbd4a5f14603b4/maintainability" /></a>
+  <a href="https://codeclimate.com/github/KennethanCeyer/pg-calendar/test_coverage"><img src="https://api.codeclimate.com/v1/badges/e46890fbd4a5f14603b4/test_coverage" /></a>
+  <a href="https://david-dm.org/kennethanceyer/pg-calendar"><img src="https://david-dm.org/kennethanceyer/pg-calendar/status.svg" alt="dependencies Status"></a>
+  <a href="https://david-dm.org/kennethanceyer/pg-calendar?type=dev"><img src="https://david-dm.org/kennethanceyer/pg-calendar/dev-status.svg" alt="devDependencies Status"></a>
+</p>
 
-### Getting started
+## :clap: Getting started
 
 PIGNOSE-Calendar helps you to make simple and eidetic datepicker with jQuery.
 
@@ -20,39 +35,27 @@ This datepicker supports responsive display and mobile environment.
 
 ![PIGNOSE-Calendar](http://www.pigno.se/barn/PIGNOSE-Calendar/demo/img/screenshot_main.png?t=201701170854)
 
-----
-
-### Documentation
+## :page_with_curl: Documentation
 
 Check [:book: GitHub wiki](https://github.com/KennethanCeyer/pg-calendar/wiki/Documentation).
 
 or [:package: Codepen.io collection](https://codepen.io/collection/Dbgpqm/)
 
-----
-
-## Installation
+## :package: Installation
 
-### NPM
+### npm
 
 ```bash
 $ npm install pg-calendar
 ```
 
-### Bower
-
-```bash
-$ bower install pg-calendar
-```
-
-### Yarn
+### yarn
 
 ```bash
 $ yarn add pg-calendar
 ```
 
-----
-
-### Usage
+## :triumph: Usage
 
 Check `dist/` folder on this repository.
 
@@ -76,9 +79,7 @@ $ git clone git@github.com:KennethanCeyer/PIGNOSE-Calendar.git
 <link type="text/css" href="./dist/css/pignose.calendar.min.css" />
 ```
 
-----
-
-### Test
+## :space_invader: Test
 
 Current version supports unit tests by using `mocha` and `chai`.
 
@@ -90,24 +91,20 @@ $ npm install
 $ npm test
 ```
 
-----
-
-### Overview
+## :beer: Overview
 
-See our features which we are supported.
+See our features which we are supported
 
-- Responsive and mobile friendly display.
-- Multiple range datepicker support.
-- Scheduling calendar support.
-- Input type controller support.
-- The toggle controll each of date buttons are supported.
-- You can disable specific dates.
-- Multiple languages are supported, (en, ko, fr, ch, de, jp, pt, da, pl, es, fa, it, cs, uk, ru).
-- Theme system supports (light, dark, blue).
+- Responsive and mobile friendly display
+- Multiple range datepicker support
+- Scheduling calendar support
+- Input type controller support
+- The toggle controll each of date buttons are supported
+- You can disable specific dates
+- Multiple languages are supported, (en, ko, fr, ch, de, jp, pt, da, pl, es, fa, it, cs, uk, ru)
+- Theme system supports (light, dark, blue)
 
-----
-
-### Contributors
+## :octocat: Contributors
 
 We welcome your support, You can support to notice by send me github issue or using gitter.
 
@@ -127,55 +124,51 @@ We welcome your support, You can support to notice by send me github issue or us
 
 Please move to [Contribution section](https://github.com/KennethanCeyer/PIGNOSE-Calendar/wiki/Contribution).
 
-----
-
-### Question
-
-If you found something problem of this plugin, or you have some question.
-
-Please send me a message to use either [gitter](https://gitter.im/KennethanCeyer/PIGNOSE) or [Github issue](https://github.com/KennethanCeyer/PIGNOSE-Calendar/issues). (gitter url is on the top of the manual)
-
-----
-
-### Todo
+## :triangular_flag_on_post: Roadmap
 
+- [x] Support Webpack, AMD and CommonJS (UMD)
+- [x] Support ES6 with babel
+- [x] Documentation supporting
+- [x] Move css file to less
+- [x] Integration with CI and Coverages
+- [x] Add unit tests
 
+**1.4.x**
 
-- [x] Support Webpack, AMD and CommonJS (UMD).
-- [x] Support ES6 with babel.
-- [x] Documentation supporting.
-- [x] Move css file to less.
-- [x] Integration with CI and Coverages.
-- [x] Add unit tests.
 - [ ] Add e2e tests.
 - [ ] Adding timepicker specs.
 - [ ] Making many sample codes.
 - [ ] Improvement and building detailed callbacks. (Progress)
+- [ ] 100% coverage unit test
+- [ ] support UMD
+- [ ] support Webpack
+- [ ] support typescript definition
+- [ ] complete documentation
 
-----
+**1.5.x**
 
-### Roadmap
+- [ ] complete examples for combination of all options
+- [ ] support e2e testing with nightwatch
+- [ ] support codepen examples
+- [ ] following convention (webstorm convention of JetBrains)
+- [ ] making integrated library with react
+- [ ] making integrated library with angular
+- [ ] making integrated library with vuejs
 
-**1.4.x**
+**1.6.x**
 
-- 100% coverage unit test
-- support UMD
-- support Webpack
-- support typescript definition
-- complete documentation
+- [ ] extended option usage `time picker`
+- [ ] advanced option `custom button (today, last 7days, last 30 days, last a month, last 6 month, last year)`
+- [ ] advanced option `attach below of input`
 
-**1.5.x**
+## :mag: License
 
-- complete examples for combination of all options
-- support e2e testing with nightwatch
-- support codepen examples
-- following convention (webstorm convention of JetBrains)
-- making integrated library with react
-- making integrated library with angular
-- making integrated library with vuejs
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FKennethanCeyer%2Fpg-calendar.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FKennethanCeyer%2Fpg-calendar?ref=badge_large)
 
-**1.6.x**
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-- extended option usage `time picker`
-- advanced option `custom button (today, last 7days, last 30 days, last a month, last 6 month, last year)`
-- advanced option `attach below of input`
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.