readme & contrib guide [ci skip]

Author: yyx990803

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Vue.js Contributing Guide
+
+Hi! I'm really excited that you are interested in contributing to Vue.js. Before submitting a pull request though, please make sure to take a moment and read through the following guidelines.
+
+## Pull Request Checklist
+
+- Work in a topic branch and merge against `dev`.
+- Squash the commit if there are too many small ones.
+- Follow the [code style](#code-style).
+- Make sure the default grunt task passes. (see [development setup](#development-setup))
+- If adding new feature:
+    - Add accompanying test case.
+    - Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
+- If fixing a bug:
+    - Provide detailed description of the bug in the PR. Live demo preferred.
+    - Add appropriate test coverage if applicable.
+
+## Code Style
+
+- [No semicolons unless necessary](http://inimino.org/~inimino/blog/javascript_semicolons).
+- 4 spaces indentation.
+- Single var definition, align equal signs where possible.
+- Return early in one line if possible.
+- When in doubt, read the source code.
+- Break long ternary conditionals:
+
+``` js
+var a = superLongConditionalStatement
+    ? 'yep'
+    : 'nope'
+```
+
+## Development Setup
+
+You will need [Node](http://nodejs.org), [Grunt](http://gruntjs.com), [Component](https://github.com/component/component), [PhantomJS](http://phantomjs.org) and [CasperJS](http://casperjs.org).
+
+``` bash
+# in case you don't already have them:
+# npm install -g grunt-cli component
+$ npm install && component install
+```
+
+To watch and auto-build `dist/vue.js` during development:
+
+``` bash
+$ grunt watch
+```
+
+To lint:
+
+``` bash
+grunt jshint
+```
+
+To build:
+
+``` bash
+$ grunt build
+```
+
+To test:
+
+``` bash
+# if you don't have these yet:
+# npm install -g phantomjs casperjs
+$ grunt test
+```
+
+The unit tests are written with Mocha + Chai and run with Karma. The functional tests are written and run with CasperJS.
+
+**If you are not using a Mac**
+
+You can modify the Gruntfile to only run Karma tests in browsers that are available on your system. Just make sure don't check in the Gruntfile for the commit.

README.md

@@ -2,48 +2,32 @@
 
 # Vue.js [![Build Status](https://travis-ci.org/yyx990803/vue.png?branch=master)](https://travis-ci.org/yyx990803/vue) [![Selenium Test Status](https://saucelabs.com/buildstatus/vuejs)](https://saucelabs.com/u/vuejs) [![Coverage Status](https://coveralls.io/repos/yyx990803/vue/badge.png)](https://coveralls.io/r/yyx990803/vue)
 
-> Simple, Fast & Composable MVVM for building interative interfaces.
+> MVVM made simple.
 
 ## Introduction
 
-Vue.js is a library that aims to simplify the development of interactive interfaces.
+Vue.js is a library for building interactive web interfaces. It provides the benefits of MVVM data binding with a simple and flexible API. You should try it out if you like:
 
-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. Actuall DOM manipulations and output formatting are abstracted away into **Directives** and **Filters**.
+- Extendable Data bindings
+- Plain JavaScript objects as models
+- Intuitive API that simply makes sense
+- The flexibility to mix & match small libraries for a custom front-end stack
 
-For more details, guides and documentations, visit [vuejs.org](http://vuejs.org).
+For more details, guides and API reference, visit [vuejs.org](http://vuejs.org).
 
 ## Browser Support
 
 Vue.js supports [most ECMAScript 5 compliant browsers](https://saucelabs.com/u/vuejs), essentially IE9+. IE9 needs [classList polyfill](https://github.com/remy/polyfills/blob/master/classList.js) and doesn't support transitions.
 
-## Development
+## Contribution
 
-``` bash
-# in case you don't already have them:
-# npm install -g grunt-cli component
-$ npm install
-$ component install
-```
+Read the [contributing guide](https://github.com/yyx990803/vue/blob/master/README.md).
 
-To build:
+## Get in Touch
 
-``` bash
-$ grunt build
-```
-
-To watch and auto-build dev version during development:
-
-``` bash
-$ grunt watch
-```
-
-To test:
-
-``` bash
-# if you don't have these yet:
-# npm install -g phantomjs casperjs
-$ grunt test
-```
+- Bugs, suggestions & feature requests: [open an issue](https://github.com/yyx990803/vue/issues)
+- Twitter: [@vuejs](https://twitter.com/vuejs)
+- freenode IRC Channel: #vuejs
 
 ## License