1
0
mirror of synced 2024-11-25 23:06:02 +03:00

Adds demo link to the readme, a few other readme clean ups

This commit is contained in:
Justin Schroeder 2018-03-14 15:37:29 -04:00
parent b6213bf0f0
commit 61bcc5da71
4 changed files with 14 additions and 14 deletions

BIN
.DS_Store vendored Normal file

Binary file not shown.

View File

@ -9,6 +9,11 @@
Vue Formulate is a [Vue](https://vuejs.org/) plugin that exposes an elegant Vue Formulate is a [Vue](https://vuejs.org/) plugin that exposes an elegant
mechanism for building and validating forms with a centralized data store. 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 ### Get Started
#### Download #### Download
@ -18,15 +23,19 @@ First download the `vue-formulate` package from npm:
npm install vue-formulate 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 ```sh
babel-preset-env babel-preset-env
babel-preset-stage-2 babel-preset-stage-2
``` ```
Many Vue/Vuex projects require Babels `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 ```sh
{ {
"presets": [ "presets": [
@ -47,12 +56,6 @@ import formulate from 'vue-formulate'
Vue.use(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 #### Vuex
`vue-formulate` needs to be linked to your vuex store. Vuex can be `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` configured as a single root store, or as namespaced modules and `vue-formualte`

View File

@ -2,7 +2,8 @@
"version": "1.0.0", "version": "1.0.0",
"author": "Justin Schroeder <justin@wearebraid.com>", "author": "Justin Schroeder <justin@wearebraid.com>",
"scripts": { "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": { "dependencies": {
"vue": "^2.3.3", "vue": "^2.3.3",

View File

@ -16,7 +16,6 @@ module.exports = {
options: { options: {
loaders: { loaders: {
} }
// other vue-loader options go here
} }
}, },
{ {
@ -44,13 +43,10 @@ module.exports = {
}, },
performance: { performance: {
hints: false hints: false
}, }
devtool: '#eval-source-map'
} }
if (process.env.NODE_ENV === 'production') { 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([ module.exports.plugins = (module.exports.plugins || []).concat([
new webpack.DefinePlugin({ new webpack.DefinePlugin({
'process.env': { 'process.env': {