Skip to content

Commit d280f50

Browse files
committed
meta info
1 parent e78fb82 commit d280f50

File tree

4 files changed

+14
-68
lines changed

4 files changed

+14
-68
lines changed

README.md

Lines changed: 8 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,20 @@
11
# VueJS [![Build Status](https://travis-ci.org/yyx990803/vue.png?branch=master)](https://travis-ci.org/yyx990803/vue)
22

3-
> Simple, fast, modular & lightweight MVVM library for building interactive user interfaces.
3+
> Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.
44
5-
## Features
5+
## Introduction
66

7-
- 10kb gzipped, no dependency.
8-
- DOM based templates with two-way data binding.
9-
- Precise and efficient DOM manipulation with granularity down to a TextNode.
10-
- POJSO (Plain Old JavaScript Objects) Models that can be shared across ViewModels with arbitrary levels of nesting.
11-
- Auto dependency tracking for expressions and computed properties.
12-
- Auto event delegation on repeated items.
13-
- Flexible API that encourages composition of components.
14-
- Extendable with custom directives and filters.
15-
- Supports partials, transitions and nested ViewModels.
16-
- 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.
7+
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)
178

189
## Browser Support
1910

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

24-
## Installation
25-
26-
**Component**
27-
28-
``` bash
29-
$ component install yyx990803/vue
30-
```
31-
32-
**Browserify**
33-
34-
``` bash
35-
$ npm install vue
36-
```
37-
38-
**Bower**
39-
40-
``` bash
41-
$ bower install vue
42-
```
43-
44-
**Module Loaders, e.g. RequireJS, SeaJS**
45-
46-
Built versions in `/dist` or installed via Bower can be used directly as a CommonJS or AMD module.
47-
48-
**Standalone**
15+
## Documentation
4916

50-
Simply include a built version in `/dist` or installed via Bower with a script tag. `Vue` will be registered as a global variable.
17+
Please see the [Wiki](https://github.com/yyx990803/vue/wiki). (under construction)
5118

5219
## Development
5320

@@ -59,48 +26,23 @@ $ component install
5926
```
6027

6128
To build:
29+
6230
``` bash
6331
$ grunt build
6432
```
6533

6634
To watch and auto-build dev version during development:
35+
6736
``` bash
6837
$ grunt watch
6938
```
7039

7140
To test (install [CasperJS](http://casperjs.org/) first):
41+
7242
``` bash
7343
$ grunt test
7444
```
7545

76-
## Quickstart
77-
78-
**HTML**
79-
80-
~~~ html
81-
<div id="demo" v-on="click:changeText">
82-
<p v-text="hello"></p>
83-
</div>
84-
~~~
85-
86-
**JavaScript**
87-
88-
~~~ js
89-
new Vue({
90-
el: '#demo',
91-
scope: {
92-
hello: 'Hello World!',
93-
changeText: function () {
94-
this.hello = 'Hello VueJS!'
95-
}
96-
}
97-
})
98-
~~~
99-
100-
## Documentation
101-
102-
Coming soon...
103-
10446
## License
10547

10648
MIT

bower.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"name": "vue",
33
"version": "0.7.2",
44
"main": "dist/vue.js",
5+
"description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.",
6+
"authors": ["Evan You <[email protected]>"],
7+
"license": "MIT",
58
"ignore": [
69
".*",
710
"examples",

component.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
"name": "vue",
33
"version": "0.7.2",
44
"main": "src/main.js",
5-
"description": "Data-driven View Models",
5+
"author": "Evan You <[email protected]>",
6+
"description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.",
67
"keywords": ["mvvm", "framework", "data binding"],
78
"license": "MIT",
89
"scripts": [

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"url": "http://evanyou.me"
88
},
99
"license": "MIT",
10-
"description": "A mini front-end MVVM framework",
10+
"description": "Lightweight, Simple, Fast & Composable MVVM library for building interactive user interfaces.",
1111
"keywords": [
1212
"mvvm",
1313
"browser",

0 commit comments

Comments
 (0)