From cefed578760ca50db64773ac328c5bfe373022d1 Mon Sep 17 00:00:00 2001 From: simon Date: Wed, 22 May 2019 14:28:39 +0200 Subject: [PATCH] refactor(readme): move upgrade isntructions after install --- README.md | 60 +++++++++++++++++++++++++------------------------------ 1 file changed, 27 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index f5aa129a..723bbd7a 100644 --- a/README.md +++ b/README.md @@ -25,9 +25,34 @@ which includes following breaking changes: * Added a beforeDateInput slot. * uses moment.js for translations (**breaking change v2+**) see [momentjs / translations](#momentjs-and-translations) * dropped internal formatting rules and also used moment.js (**breaking change 2.x+**) see [momentjs / formatting](#momentjs-and-formatting) -To install this fork, use: + +## Demo + +To view a demo online: +https://codesandbox.io/s/vue-datepicker-demo-82x48 + +To view demo examples locally clone the repo and run `npm install && npm run serve` + +## Install + +``` bash +npm install @hokify/vuejs-datepicker ``` -npm install --save @hokify/vuejs-datepicker +or +``` bash +yarn add @hokify/vuejs-datepicker +``` + +``` javascript +import Datepicker from '@hokify/vuejs-datepicker'; + +export default { + // ... + components: { + Datepicker + } + // ... +} ``` ## Upgrade @@ -59,37 +84,6 @@ Examples: | dsu MMM yyyy | Do MMM YYYY | 12th Feb 2016 | | D dsu MMM yyyy | ddd Do MMM YYYY | Sat 12th Feb 2016 | - -## Demo - -To view a demo online: -https://codesandbox.io/s/vue-datepicker-demo-82x48 - -To view demo examples locally clone the repo and run `npm install && npm run serve` - -## Install - -``` bash -npm install @hokify/vuejs-datepicker -``` -or -``` bash -yarn add @hokify/vuejs-datepicker -``` - -``` javascript -import Datepicker from '@hokify/vuejs-datepicker'; - -export default { - // ... - components: { - Datepicker - } - // ... -} -``` - - ### regarding CSS As this bundle is also useable for SSR rendering, you have to take care of css yourself. (see also https://github.com/vuejs/rollup-plugin-vue/issues/266)