Skip to content

Commit

Permalink
meta info
Browse files Browse the repository at this point in the history
  • Loading branch information
yyx990803 committed Dec 28, 2013
1 parent e78fb82 commit d280f50
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 68 deletions.
74 changes: 8 additions & 66 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,20 @@
# 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

- Most Webkit/Blink-based browsers
- Firefox 4+
- IE9+ (IE9 needs [classList polyfill](https://github.com/remy/polyfills/blob/master/classList.js) and doesn't support transitions)

## Installation

**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**
## Documentation

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

Expand All @@ -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
<div id="demo" v-on="click:changeText">
<p v-text="hello"></p>
</div>
~~~

**JavaScript**

~~~ js
new Vue({
el: '#demo',
scope: {
hello: 'Hello World!',
changeText: function () {
this.hello = 'Hello VueJS!'
}
}
})
~~~

## Documentation

Coming soon...

## License

MIT
3 changes: 3 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -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 <yyx990803@gmail.com>"],
"license": "MIT",
"ignore": [
".*",
"examples",
Expand Down
3 changes: 2 additions & 1 deletion component.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"name": "vue",
"version": "0.7.2",
"main": "src/main.js",
"description": "Data-driven View Models",
"author": "Evan You <yyx990803@gmail.com>",
"description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.",
"keywords": ["mvvm", "framework", "data binding"],
"license": "MIT",
"scripts": [
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit d280f50

Please sign in to comment.