README.md in vuejs-1.1.0.beta2 vs README.md in vuejs-1.1.0.beta3
- old
+ new
@@ -1,6 +1,6 @@
-# Vuejs Gem
+# 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.
@@ -24,58 +24,67 @@
And then execute:
$ bundle
-# Webpacker
+## Get started
-## Vue component generator
+To generate an empty Vue on Rails project with all its dependencies, run Rails with its application template
```
+rails new app -m http://vueonrails.com/vue
+```
+
+To browse the application template, it's here http://vueonrails.com/vue
+
+
+## Generate a new Vue component
+
+```
rails generate vue something
```
Note: `vuejs` gem creates vue components as single-file component by default.
-To generate a component with seperation of concern, please use the `--seperate`
+To generate a component with seperation of concern, please use the option `--seperate`,
+like `rails g vue something --seperate`
> rails g vue something --seperate
-## Vue component destroyer
+## Destroy a Vue component
```
rails destroy vue something
```
-## Vue component viewer
+## View a standalone Vue component
Vue-component viewer allows you to browse your individual & independent Vue component easily without its surrounding element outside the scope of the component. Simply visit http://localhost:3000/vue/<name>
To mount the endpoint `/vue/<name>`, go to routes.rb and paste this:
```
mount Vuejs::engine, to: 'vue'
```
-## Turbolinks support
+
+## Generate a Vue component with Turbolinks support
```
rails generate vue something --turbolinks
```
-## Vuex support - coming soon
+## Generate a Vue component with Vuex support
```
rails generate vue something --vuex
```
-This will add vuex using yarn. And generate a vue component with vuex support
+## Generate a Vue component with Specific Page Vue support
-## Enable Specific page vue
-
```
rails generate vue something --spv
```
-### Generate unit tests for component - coming soon
+## Generate a Vue component with unit tests
```
rails generate vue something --test
```
---