mirror of
https://github.com/Hopiu/vue-material.git
synced 2026-03-16 22:10:27 +00:00
Add a small readme
This commit is contained in:
parent
540007d4f2
commit
fd3029b162
1 changed files with 19 additions and 12 deletions
31
README.md
31
README.md
|
|
@ -2,26 +2,33 @@
|
|||
|
||||
> Material Design for Vue.js
|
||||
|
||||
Vue Material is lightweight framework built exactly according to the [Material Design](http://material.google.com) specs. Build powerful and well-designed web apps that can can fit on every screen. You can generate and use themes dynamically, use components on demand, take advantage of UI Elements and Components with an ease-to-use API and more...
|
||||
It aims to deliver a collection of reusable components and a series of UI Elements to build applications with support to [modern Web Browsers](https://saucelabs.com/u/vuejs) through Vue 2.0.
|
||||
|
||||
## Build Setup
|
||||
|
||||
``` bash
|
||||
### install dependencies
|
||||
npm install
|
||||
### Install dependencies
|
||||
npm install or yarn
|
||||
|
||||
### serve with hot reload at localhost:8080
|
||||
### Start dev server with hot reload
|
||||
npm run dev
|
||||
|
||||
### build for production with minification
|
||||
### Build everything
|
||||
npm run build
|
||||
|
||||
### run unit tests
|
||||
npm run unit
|
||||
### Build docs only
|
||||
npm run build:docs
|
||||
|
||||
### run e2e tests
|
||||
npm run e2e
|
||||
|
||||
### run all tests
|
||||
npm test
|
||||
### Build lib only
|
||||
npm run build:lib
|
||||
```
|
||||
|
||||
For detailed explanation on how things work, checkout the [guide](http://vuejs-templates.github.io/webpack/) and [docs for vue-loader](http://vuejs.github.io/vue-loader).
|
||||
## Credits and Thanks
|
||||
This library aims to delivery components using almost the same API of [Angular Material](https://material.angularjs.org/latest/)
|
||||
Thanks to [elviskang](https://github.com/elviskang) who provided to me the **vue-material** name on npm.
|
||||
|
||||
## Dependencies
|
||||
[autosize](http://www.jacklmoore.com/autosize/)
|
||||
[element.scrollintoviewifneeded-polyfill](https://www.npmjs.com/package/element.scrollintoviewifneeded-polyfill)
|
||||
[scopedQuerySelectorShim](https://github.com/lazd/scopedQuerySelectorShim)
|
||||
|
|
|
|||
Loading…
Reference in a new issue