Browse Source

add readme

dev
Evan You 8 years ago
parent
commit
33bd50993a
  1. 91
      README.md

91
README.md

@ -1,12 +1,87 @@
# vue-next [![CircleCI](https://img.shields.io/circleci/project/vuejs/vue/next.svg?maxAge=2592000)](https://circleci.com/gh/vuejs/vue/tree/next) [![Coverage](https://img.shields.io/codecov/c/github/vuejs/vue/next.svg)](https://codecov.io/gh/vuejs/vue/branch/next) [![Sauce Labs](https://saucelabs.com/open_sauce/build_status/vuejs.svg)](https://saucelabs.com/beta/builds/03f78da5c56a4e61bb80c61f1c01d7d8)
<p align="center"><a href="http://vuejs.org" target="_blank"><img width="100"src="http://vuejs.org/images/logo.png"></a></p>
### Current status: BETA
<p align="center">
<a href="https://circleci.com/gh/vuejs/vue/tree/master"><img src="https://img.shields.io/circleci/project/vuejs/vue/master.svg" alt="Build Status"></a>
<a href="https://codecov.io/github/vuejs/vue?branch=master"><img src="https://img.shields.io/codecov/c/github/vuejs/vue/dev.svg" alt="Coverage Status"></a>
<a href="https://www.npmjs.com/package/vue"><img src="https://img.shields.io/npm/dt/vue.svg" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/vue"><img src="https://img.shields.io/npm/v/vue.svg" alt="Version"></a>
<a href="https://www.npmjs.com/package/vue"><img src="https://img.shields.io/npm/l/vue.svg" alt="License"></a>
<br>
<a href="https://saucelabs.com/u/vuejs"><img src="https://saucelabs.com/browser-matrix/vuejs.svg" alt="Sauce Test Status"></a>
</p>
Checkout the [2.0 Changes](https://github.com/vuejs/vue/issues/2873) issue or the [WIP documentation](https://github.com/vuejs/vuejs.org/tree/2.0/src/guide).
## Supporting Vue.js
### Build
Vue.js is an MIT-licensed open source project. Its ongoing development is made possible thanks to the support by these awesome [backers](https://github.com/vuejs/vue/blob/dev/backers.md). If you'd like to join them, check out [Vue.js' Patreon campaign](https://www.patreon.com/evanyou).
``` bash
npm install
npm run build
```
**Special thanks to the generous sponsorship by:**
<a href="https://strikingly.com/s/careers?utm_source=v">
<img width="240px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/strikingly.png">
</a>
<a href="http://www.itunescn.com/">
<img width="160px" src="https://www.zymmm.com/content/images/2016/05/itunescn-logo-4.png">
</a>
<a href="https://jsfiddle.net/">
<img width="160px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/jsfiddle.png">
</a>
<a href="https://laravel.com/">
<img width="160px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/laravel.png">
</a>
<a href="https://chaitin.cn/">
<img width="160px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/chaitin.png">
</a>
<a href="https://htmlburger.com/">
<img width="160px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/htmlburger.png">
</a>
<a href="https://starter.someline.com/">
<img width="160px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/someline.png">
</a>
<a href="http://gold.xitu.io/?utm_source=vuejs&utm_medium=image&utm_content=juejin&utm_campaign=q3_website">
<img width="120px" src="https://raw.githubusercontent.com/vuejs/vuejs.org/master/themes/vue/source/images/juejin.png">
</a>
## Intro
Vue.js is a library for building interactive web interfaces. It provides data-reactive components with a simple and flexible API. Core features include:
- [Dead simple, unobtrusive reactivity using plain JavaScript objects.](http://vuejs.org/guide/overview.html#Reactive-Data-Binding)
- [Component-oriented development style with tooling support](http://vuejs.org/guide/overview.html#Component-System)
- Lean and extensible core
- [Flexible transition effect system](http://vuejs.org/guide/transitions.html)
- Fast without the need for complex optimization
Note that Vue.js only supports [ES5-compliant browsers](http://kangax.github.io/compat-table/es5/) (IE8 and below are not supported). To check out live examples and docs, visit [vuejs.org](http://vuejs.org).
## Questions
For questions and support please use the [Gitter chat room](https://gitter.im/vuejs/vue) or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.
## Issues
Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
## Contribution
Please make sure to read the [Contributing Guide](https://github.com/vuejs/vue/blob/dev/CONTRIBUTING.md) before making a pull request. If you have a Vue-related project/component/tool, add it with a pull-request to [this curated list](https://github.com/vuejs/awesome-vue)!
## Changelog
Details changes for each release are documented in the [release notes](https://github.com/vuejs/vue/releases).
## Stay In Touch
- For latest releases and announcements, follow on Twitter: [@vuejs](https://twitter.com/vuejs)
## License
[MIT](http://opensource.org/licenses/MIT)
Copyright (c) 2013-2016 Evan You

Loading…
Cancel
Save