From d280f50cecb4cc69b757485b283d89da29ab7112 Mon Sep 17 00:00:00 2001 From: Evan You Date: Sat, 28 Dec 2013 16:50:53 -0500 Subject: [PATCH] meta info --- README.md | 74 ++++++-------------------------------------------- bower.json | 3 ++ component.json | 3 +- package.json | 2 +- 4 files changed, 14 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 8a599a5fc..ae4643661 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,10 @@ # VueJS [![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. +> 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 -
-

-
-~~~ - -**JavaScript** - -~~~ js -new Vue({ - el: '#demo', - scope: { - hello: 'Hello World!', - changeText: function () { - this.hello = 'Hello VueJS!' - } - } -}) -~~~ - -## Documentation - -Coming soon... - ## License MIT \ No newline at end of file diff --git a/bower.json b/bower.json index 518f647b1..4a748a4cb 100644 --- a/bower.json +++ b/bower.json @@ -2,6 +2,9 @@ "name": "vue", "version": "0.7.2", "main": "dist/vue.js", + "description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.", + "authors": ["Evan You "], + "license": "MIT", "ignore": [ ".*", "examples", diff --git a/component.json b/component.json index 9357dc134..48d2736ab 100644 --- a/component.json +++ b/component.json @@ -2,7 +2,8 @@ "name": "vue", "version": "0.7.2", "main": "src/main.js", - "description": "Data-driven View Models", + "author": "Evan You ", + "description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.", "keywords": ["mvvm", "framework", "data binding"], "license": "MIT", "scripts": [ diff --git a/package.json b/package.json index d81966fc6..8cd063ea5 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "url": "http://evanyou.me" }, "license": "MIT", - "description": "A mini front-end MVVM framework", + "description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.", "keywords": [ "mvvm", "browser",