README.md in vuejs-1.1.0.beta3 vs README.md in vuejs-1.1.0.beta4

- old
+ new

@@ -1,33 +1,25 @@ # Welcome to Vuejs Gem > Vue for your favourite Ruby on Rails projects -`vuejs` rubygem makes it easy to get started with Vue on Rails project by shipping the following tools. +`vuejs` rubygem makes it easy to get started with Vue on Rails project. To create an empty Vue on Rails project, please run the following command -- Vuex support -- HTML Form helper -- Turbolinks support -- Support Webpacker -- Vue component Scaffold -- Mapping to Rails resources -- Auto-loading of Vue component -- Vue-cli service & Vue-ui compatibility -- Unit component tests compatible to vue-tests-utils using Jest +``` +rails new app -m http://vueonrails.com/vue +``` ## Installation -Add this line to your application's Gemfile: +Add this line to your application's Gemfile and run `bundle` ```ruby gem 'vuejs' ``` -And then execute: +and run `rails vue:setup` - $ bundle - ## Get started To generate an empty Vue on Rails project with all its dependencies, run Rails with its application template ``` @@ -37,23 +29,26 @@ To browse the application template, it's here http://vueonrails.com/vue ## Generate a new Vue component +To generate a new vue component is easy. Please run the following command: + ``` rails generate vue something ``` -Note: `vuejs` gem creates vue components as single-file component by default. +> Note: `vuejs` gem creates vue components as single-file component by default. To generate a component with seperation of concern, please use the option `--seperate`, like `rails g vue something --seperate` > rails g vue something --seperate ## Destroy a Vue component +To destroy a vue component is easy. Please run: ``` rails destroy vue something ``` ## View a standalone Vue component @@ -65,10 +60,11 @@ ``` mount Vuejs::engine, to: 'vue' ``` ## Generate a Vue component with Turbolinks support + ``` rails generate vue something --turbolinks ``` ## Generate a Vue component with Vuex support @@ -86,9 +82,12 @@ ## Generate a Vue component with unit tests ``` rails generate vue something --test ``` + +## Passing Rails Variable into Vue component - coming soon + --- # Some Solution for assets pipeline ### Sprockets::FileNotFound: couldn't find file 'vue-validator'