diff --git a/README.md b/README.md index 8a599a5fc..ae4643661 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,10 @@ # VueJS [](https://travis-ci.org/yyx990803/vue) -> Simple, fast, modular & lightweight MVVM library for building interactive user interfaces. +> Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces. -## Features +## Introduction -- 10kb gzipped, no dependency. -- 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. -- Auto dependency tracking for expressions and computed properties. -- Auto event delegation on repeated items. -- 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. +VueJS is a library for building interactive interfaces. It provides the **ViewModel** layer of the MVVM pattern, which connects the **View** (the actual HTML that the user sees) and the **Model** (JSON-compliant plain JavaScript objects) via two way data-bindings. [Read more.](https://github.com/yyx990803/vue/wiki/What-is-VueJS) ## Browser Support @@ -21,33 +12,9 @@ - Firefox 4+ - IE9+ (IE9 needs [classList polyfill](https://github.com/remy/polyfills/blob/master/classList.js) and doesn't support transitions) -## Installation +## Documentation -**Component** - -``` bash -$ component install yyx990803/vue -``` - -**Browserify** - -``` bash -$ npm install vue -``` - -**Bower** - -``` bash -$ bower install vue -``` - -**Module Loaders, e.g. RequireJS, SeaJS** - -Built versions in `/dist` or installed via Bower can be used directly as a CommonJS or AMD module. - -**Standalone** - -Simply include a built version in `/dist` or installed via Bower with a script tag. `Vue` will be registered as a global variable. +Please see the [Wiki](https://github.com/yyx990803/vue/wiki). (under construction) ## Development @@ -59,48 +26,23 @@ $ component install ``` To build: + ``` bash $ grunt build ``` To watch and auto-build dev version during development: + ``` bash $ grunt watch ``` To test (install [CasperJS](http://casperjs.org/) first): + ``` bash $ grunt test ``` -## Quickstart - -**HTML** - -~~~ html -