Skip to content

Commit

Permalink
Update the name
Browse files Browse the repository at this point in the history
  • Loading branch information
Damian Dulisz committed Nov 29, 2016
1 parent b89c6ee commit 70ddd7f
Show file tree
Hide file tree
Showing 15 changed files with 39 additions and 34 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# vue-validation
# vuelidate

> Simple, lightweight model-based validation for Vue.js
Expand Down
4 changes: 2 additions & 2 deletions build/webpack.base.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ var env = process.env.NODE_ENV
// check env & config/index.js to decide weither to enable CSS Sourcemaps for the
// various preprocessor loaders added to vue-loader at the end of this file
var cssSourceMapDev = (env === 'development' && config.dev.cssSourceMap)
var cssSourceMapProd = (env === 'production' && config.build.productionSourceMap)
var cssSourceMapProd = (env === 'production' && config.docs.productionSourceMap)
var useCssSourceMap = cssSourceMapDev || cssSourceMapProd

module.exports = {
Expand All @@ -24,7 +24,7 @@ module.exports = {
fallback: [path.join(__dirname, '../node_modules')],
alias: {
'vue$': 'vue/dist/vue',
'vue-validations/lib/validators': path.resolve(__dirname, '../src/validators'), // for consistent docs
'vuelidate/lib/validators': path.resolve(__dirname, '../src/validators'), // for consistent docs
'src': path.resolve(__dirname, '../src'),
'assets': path.resolve(__dirname, '../docs/assets'),
'examples': path.resolve(__dirname, '../docs/partials/examples'),
Expand Down
2 changes: 1 addition & 1 deletion build/webpack.bundle.conf.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const config = require('../config')
// refer to .babelrc for lib configuration

base.entry = {
'vue-validations': './src/index.js',
'vuelidate': './src/index.js',
'validators': './src/validators/index.js'
}

Expand Down
8 changes: 4 additions & 4 deletions docs/index.pug
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ html(lang="en")
head
meta(charset='utf-8')
meta(name='viewport', content='width=device-width,initial-scale=1,maximum-scale=1')
title vue-validations | A Vue.js library
title Vuelidate | A Vue.js model validation library
link(rel='icon', href=require('assets/vue-logo.png'), type='image/x-icon')
meta(name='description', content='Simple, lightweight model-based validation for Vue.js')
meta(property='og:title', content='vue-validations | A Vue.js library.')
meta(property='og:site_name', content='vue-validations | A Vue.js library.')
meta(property='og:title', content='Vuelidate | A Vue.js library.')
meta(property='og:site_name', content='Vuelidate | A Vue.js library.')
meta(property='og:url', content='http://monterail.github.io/vue-multiselect')
meta(property='og:description', content='Simple, lightweight model-based validation for Vue.js')
meta(property='og:image', content='http://monterail.github.io/vue-multiselect/static/vue-logo.png')
meta(property='twitter:image', content='http://monterail.github.io/vue-multiselect/static/vue-logo.png')
meta(property='twitter:title', content='vue-validations | A Vue.js library.')
meta(property='twitter:title', content='Vuelidate | A Vue.js library.')
meta(property='twitter:description', content='Simple, lightweight model-based validation for Vue.js')
body
#app
Expand Down
10 changes: 6 additions & 4 deletions docs/partials/_getting-started.pug
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,29 @@
+subsection('Package content')
p.typo__p
| Simple, lightweight model-based validation for Vue.js
p.typo__p
| You can read the <a class="typo__link" href="http://monterail.com/blog/2016/rethinking-validations-for-vue-js/" alt="Rethinking validations for vue.js" target="_BLANK">introduction post</a> for more insight on how this solution differs from other validation libraries.
+subsection('Installation')
p.typo__p
| Package is installable via npm
pre.language-bash
code.
npm install vue-validations --save
npm install vuelidate --save
+subsection('Basic usage')
p.typo__p
| You can import the library and <kbd>use</kbd> as a Vue plugin to enable
| the functionality globally on all components containing validation configuration.
pre.language-javascript
code.
import Vue from 'vue'
import Validation from 'vue-validation'
import Validation from 'vuelidate'
Vue.use(Validation)
p.typo__p
| Alternatively it is possible to import a mixin directly to components
| in which it will be used.
pre.language-javascript
code.
import { validationMixin } from 'vue-validation'
import { validationMixin } from 'vuelidate'

var Component = Vue.extend({
mixins: [validationMixin],
Expand All @@ -31,7 +33,7 @@
p.typo__p
| The browser-ready bundle is also provided in the package.
pre(v-pre).language-html
code='<script src="vue-validations/dist/vue-validation.min.js"></script>'
code='<script src="vuelidate/dist/vuelidate.min.js"></script>'
pre.language-javascript
code.
Vue.use(window.Validation)
21 changes: 12 additions & 9 deletions docs/partials/_start.pug
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,32 @@ section.start(v-bind:style="gradient")
.center-vertically
h1.typo__h1
img.logo(src=require('assets/vue-logo.png'))
| vue-validations
| Vuelidate
small.version (0.1.0)
h3.typo__h3
| Simple, lightweight model-based validation for
= ' '
a.typo__link(href="http://vuejs.org" target="_BLANK") Vue.js
a.typo__link(href="http://vuejs.org" target="_BLANK") Vue.js 2.0

.grid__row.grid__row--centered
.grid__column.grid__unit--md-6
.multiselect-example__container
.grid__row.start__list
.grid__column.grid__unit--md-6.list
ul.list__ul
li.typo__li Perks here
li.typo__li And here
li.typo__li: a.typo__link(href="#search") And here with a link
li.typo__li Model based
li.typo__li Decoupled from templates
li.typo__li Dependency free, minimalistic library
li.typo__li: a.typo__link(href="#sub-collections-validation") Support for collection validations
li.typo__li: a.typo__link(href="#sub-data-nesting") Support for nested models
.grid__column.grid__unit--md-6.list
ul.list__ul
li.typo__li Perks here
li.typo__li And here
li.typo__li: a.typo__link(href="#search") And here with a link
li.typo__li: a.typo__link(href="#sub-contextified-validators") Contextified valdiators
li.typo__li Easy to use with custom validators (e.g. Moment.js)
li.typo__li Support for function composition
li.typo__li Validates different data sources: Vuex getters, coumputed values, etc.

.grid__row.grid__row--centered
.grid__column.utils--center
a.button.button--large.button--secondary.button--github(href="https://github.com/monterail" target="_BLANK") View on GitHub
a.button.button--large.button--secondary.button--github(href="https://github.com/monterail/vuelidate" target="_BLANK") View on GitHub
a.button.button--large(href="#getting-started") Getting started & examples
2 changes: 1 addition & 1 deletion docs/partials/api/_api.pug
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+section('API')
p.typo__p
| There are two distinct structures present in <em>vue-validation</em>:
| There are two distinct structures present in <em>vuelidate</em>:
ul
li <kbd>validations</kbd> component option - the definition of your validation
li <kbd>$v</kbd> structure - an object in your viewmodel that holds the validation state
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/examples/ExampleBasic.vue
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</template>

<script>
import { required, minLength, between } from 'vue-validations/lib/validators'
import { required, minLength, between } from 'vuelidate/lib/validators'
export default {
data () {
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/examples/ExampleEachArray.vue
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</template>

<script>
import { required, minLength } from 'vue-validations/lib/validators'
import { required, minLength } from 'vuelidate/lib/validators'
export default {
data () {
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/examples/ExampleNested.vue
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</template>

<script>
import { required } from 'vue-validations/lib/validators'
import { required } from 'vuelidate/lib/validators'
export default {
data () {
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/examples/ExampleRepeatPassword.vue
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
</template>

<script>
import { required, sameAs, minLength } from 'vue-validations/lib/validators'
import { required, sameAs, minLength } from 'vuelidate/lib/validators'
export default {
data () {
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/examples/ExampleValidationGroups.vue
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</template>

<script>
import { required } from 'vue-validations/lib/validators'
import { required } from 'vuelidate/lib/validators'
export default {
data () {
Expand Down
10 changes: 5 additions & 5 deletions docs/partials/validators/_validators.pug
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ mixin validatorRow(validator, params)

+section('Validators')
p.typo__p
| <em>vue-validations</em> comes with a set of builtin validators that you
| <em>vuelidate</em> comes with a set of builtin validators that you
| can just require and use, but it doesn't end there. All of those are just
| simple predicates - functions of data into <kbd>boolean</kbd>, which denotes
| if data is valid. You can easily write your own
Expand All @@ -28,18 +28,18 @@ mixin validatorRow(validator, params)
| To use any of builtin validators, you have to import it from your sources.
pre(v-pre).language-javascript
code.
import { required, maxLength } from 'vue-validations/lib/validators'
import { required, maxLength } from 'vuelidate/lib/validators'
p.typo__p
| You can also import specific validators directly, to avoid loading
| unused ones in case your bundler doesn't support tree shaking.
pre(v-pre).language-javascript
code.
import required from 'vue-validations/lib/validators/required'
import maxLength from 'vue-validations/lib/validators/maxLength'
import required from 'vuelidate/lib/validators/required'
import maxLength from 'vuelidate/lib/validators/maxLength'
p.typo__p
| It is possible to use validators directly in browser by using a browser-ready bundle.
pre(v-pre).language-html
code='<script src="vue-validations/dist/validators.min.js"></script>'
code='<script src="vuelidate/dist/validators.min.js"></script>'
pre(v-pre).language-javascript
code.
var required = validators.required
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<title>vue-validation</title>
<title>vuelidate</title>
</head>
<body>
<div id="app"></div>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "vue-validation",
"name": "vuelidate",
"version": "0.1.0",
"description": "Simple, lightweight model-based validation for Vue.js",
"contributors": [
Expand Down

0 comments on commit 70ddd7f

Please sign in to comment.