From 9758efe8dfbb5e4dd9a45b619b322b12e0503733 Mon Sep 17 00:00:00 2001 From: Evan You Date: Mon, 23 Dec 2013 21:37:03 -0500 Subject: [PATCH] readme + grunt build --- Gruntfile.js | 6 ++++++ README.md | 28 ++++++++++++++++------------ 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index fc7d5ff40..f4053dd45 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -86,6 +86,12 @@ module.exports = function( grunt ) { require('./' + path)(grunt) }) + grunt.registerTask( 'build', [ + 'componentbuild', + 'uglify', + 'size' + ]) + grunt.registerTask( 'test', [ 'componentbuild', 'jsc', diff --git a/README.md b/README.md index 8d8a0bd15..8a599a5fc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -# VueJS +# VueJS [![Build Status](https://travis-ci.org/yyx990803/vue.png?branch=master)](https://travis-ci.org/yyx990803/vue) -Data-driven, modular & lightweight ViewModels - -[![Build Status](https://travis-ci.org/yyx990803/vue.png?branch=master)](https://travis-ci.org/yyx990803/vue) +> Simple, fast, modular & lightweight MVVM library for building interactive user interfaces. ## Features @@ -10,11 +8,11 @@ Data-driven, modular & lightweight ViewModels - DOM based templates with two-way data binding. - Precise and efficient DOM manipulation with granularity down to a TextNode. - POJSO (Plain Old JavaScript Objects) Models that can be shared across ViewModels with arbitrary levels of nesting. -- Extendable with custom directives and filters. -- Auto dependency extraction for computed properties. +- Auto dependency tracking for expressions and computed properties. - Auto event delegation on repeated items. -- Flexible API that allows easy encapsulation of components. -- Supports partials, transitions and nested view models. +- Flexible API that encourages composition of components. +- Extendable with custom directives and filters. +- Supports partials, transitions and nested ViewModels. - Plays well with module systems. Primarily [Component](https://github.com/component/component) based, but can also be used with [Browserify](https://github.com/substack/node-browserify), as a CommonJS/AMD module or as a standalone library. ## Browser Support @@ -27,15 +25,21 @@ Data-driven, modular & lightweight ViewModels **Component** - $ component install yyx990803/vue +``` bash +$ component install yyx990803/vue +``` **Browserify** - $ npm install vue +``` bash +$ npm install vue +``` **Bower** - $ bower install vue +``` bash +$ bower install vue +``` **Module Loaders, e.g. RequireJS, SeaJS** @@ -56,7 +60,7 @@ $ component install To build: ``` bash -$ grunt componentbuild +$ grunt build ``` To watch and auto-build dev version during development: