From 61bcc5da710d7cf2e91adec1994b39872c16de99 Mon Sep 17 00:00:00 2001 From: Justin Schroeder Date: Wed, 14 Mar 2018 15:37:29 -0400 Subject: [PATCH] Adds demo link to the readme, a few other readme clean ups --- .DS_Store | Bin 0 -> 6148 bytes README.md | 19 +++++++++++-------- example/package.json | 3 ++- example/webpack.config.js | 6 +----- 4 files changed, 14 insertions(+), 14 deletions(-) create mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..edf4605d80b02d7a6dadb7f99156202b943ea705 GIT binary patch literal 6148 zcmeHK%}(1u5S|Tbu^Xv!B@Q5QScyX~IfN9I9<3BOA%QR|hyDaxUNx3nJ8~RSDT-wA z06YL(`FW6*cj%M!%*^hlDouL?K{X@Ie&hLD`?Iy{1pv_*#;X7x063_GH5Z4!2*pWf zq-H&YLigxH3Mv{6`cXQQ&5no20KL0;Q1BH(_yWJZzdXXo�d!gR<57A!>8=Cr{@c z_gTYjJa4!kgI+!g%CH;`I$_cEmV+c#QCJ)#aoO8f*=DMaRJK!WhovgsQ}TYEru zFnX7$QP*2|n`dR1WUA2pOpgx-Nfzg$PCm@yfzG$hwY?jbJ?!JG_=(hvx{llRmd4}N z_FB6s+wC`#rW~)Yx0-V8)$7T`b)2P_TYH~|$0w&}=NFe(-@fZI5cth%d0}x1*J%8~ z$x%>bX`X$?$h2yj&BzQe1I)nVW5BLtPUG?2I^Qufzzp0m1GGL!R6^fkWl%32IMDAS z#p{G5XwzAOP+IgYRt7PGB1|cwDHZmJAxt^?rOop#Rt8Nu2t70Qu`>&MLJ@j)^h=!% z!Z*kxGr$boW?;@-dbIy<{`>rYyNIut0cPO8VnEb4f{hM7lHFTp9**`}iF$}iLV1h#nOF5zsX7zzp0g12-6nV!Z$W literal 0 HcmV?d00001 diff --git a/README.md b/README.md index 1eacf50..0c53afc 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,11 @@ Vue Formulate is a [Vue](https://vuejs.org/) plugin that exposes an elegant mechanism for building and validating forms with a centralized data store. +### Show and tell + +You'll find an easy to use example, in [the example directory](https://github.com/wearebraid/vue-formulate/tree/master/example) +as well as a live demo available at: [demo.vueformulate.com](https://demo.vueformulate.com). + ### Get Started #### Download @@ -18,15 +23,19 @@ First download the `vue-formulate` package from npm: npm install vue-formulate ``` -You will require Babel so... +If you want to use ES6 features in your project +(and this readme assumes you do), then you'll also +need Babel: ```sh babel-preset-env babel-preset-stage-2 ``` +Many Vue/Vuex projects require Babel’s `stage-2` preset. +Best practice is to include a `.babelrc` in the project +root: -... and ensure a `.babelrc` is in the project root and includes ... ```sh { "presets": [ @@ -47,12 +56,6 @@ import formulate from 'vue-formulate' Vue.use(formulate) ``` - -#### Examples - -You'll find an easy to use example, with getting started instructions, in [the example directory](https://github.com/wearebraid/vue-formulate/tree/master/example) - - #### Vuex `vue-formulate` needs to be linked to your vuex store. Vuex can be configured as a single root store, or as namespaced modules and `vue-formualte` diff --git a/example/package.json b/example/package.json index d68c12f..62c48c4 100644 --- a/example/package.json +++ b/example/package.json @@ -2,7 +2,8 @@ "version": "1.0.0", "author": "Justin Schroeder ", "scripts": { - "dev": "cross-env NODE_ENV=development webpack-dev-server --hot" + "dev": "cross-env NODE_ENV=development webpack-dev-server --hot", + "build": "cross-env NODE_ENV=production webpack -p" }, "dependencies": { "vue": "^2.3.3", diff --git a/example/webpack.config.js b/example/webpack.config.js index beb773d..0a23354 100644 --- a/example/webpack.config.js +++ b/example/webpack.config.js @@ -16,7 +16,6 @@ module.exports = { options: { loaders: { } - // other vue-loader options go here } }, { @@ -44,13 +43,10 @@ module.exports = { }, performance: { hints: false - }, - devtool: '#eval-source-map' + } } if (process.env.NODE_ENV === 'production') { - module.exports.devtool = '#source-map' - // http://vue-loader.vuejs.org/en/workflow/production.html module.exports.plugins = (module.exports.plugins || []).concat([ new webpack.DefinePlugin({ 'process.env': {