README.md in vuejs-1.1.0.beta8 vs README.md in vuejs-1.1.0.beta9

- old
+ new

@@ -1,139 +1,68 @@ -# Welcome to 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. To create an empty Vue on Rails project, please run the following command +This gem aims to make it easy and simple to run Vue on Rails project. It ships out-of-the-box configuration, component generators and solutions to make life easy for both Vue and Rails. -``` -rails new app -m http://vueonrails.com/vue -``` +--- -## Installation +## Getting Started -Add this line to your application's Gemfile and run `bundle` +To create an empty Vue on Rails project, please run the following Rails command with an application template -```ruby -gem 'vuejs' ``` - -and run `rails vue:setup` - -## Get started - -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 +To browse the application template, it's here http://vueonrails.com/vue -## Generate a new Vue component +## Manual Installation -To generate a new vue component is easy. Please run the following command: +Add this line to your application's Gemfile and run `bundle` +```ruby +gem 'vuejs' ``` -rails generate vue something -``` -> Note: `vuejs` gem creates vue components as single-file component by default. +and run `rails vue:setup` -To generate a component with seperation of concern, please use the option `--seperate`, -like `rails g vue something --seperate` +You can scaffold a Vue component by reading along the [Vue on Rails Handbook](/vueonrails/tree/master/docs) -> rails g vue something --seperate +--- -## Destroy a Vue component +## Getting Help & Contributing Back -To destroy a vue component is easy. Please run: -``` -rails destroy vue something -``` +- [Official Rails documentation](https://guides.rubyonrails.org) +- [Official Vue documentation](https://vuejs.org/v2/guide/) +- [vuecomponents.com](https://vuecomponents.com) +- [Official Find vue curated component](https://curated.vuejs.org) +- [vuetoolbox.com](http://www.vuetoolbox.com) +- [github search for vue stuffs](https://github.com/search?o=desc&q=vue&s=stars&type=Repositories) +- [stackoverflow.com](https://stackoverflow.com/questions/tagged/vue.js+ruby-on-rails) -## 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> +On stackoverflow.com, tag your Vue on Rails questions with Vue & Rails and we will try to answer you. -To mount the endpoint `/vue/<name>`, go to routes.rb and paste this: +- And it is likely that I missed some great online materials. If you think there is a more worthy resource, please edit this readme via a pull request. -``` -mount Vuejs::engine, to: 'vue' -``` +- Find a bug? [Submit an issue](https://github.com/ytbryan/vueonrails/issues) on our tracker. -## Generate a Vue component with Turbolinks support +- Find something wrong? [Send a pull request](https://github.com/ytbryan/vueonrails/pulls). -``` -rails generate vue something --turbolinks -``` +--- -## Generate a Vue component with Vuex support +## Contact -``` -rails generate vue something --vuex -``` +📮 Bryan Lim ytbryan@gmail.com -## Generate a Vue component with Specific Page Vue support +> If you are using Vue.js via this rubygem, please let me know so that I can list your project/company on this repo. Thank you! -``` -rails generate vue something --spv -``` +Richard LaFranchi and I are writing a book [Vue on rails](http://vueonrails.com). If you are interested to be one of the early reviewers of our drafts, please email me. -## 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 +## MIT License -### Sprockets::FileNotFound: couldn't find file 'vue-validator' - -``` -Sprockets::FileNotFound: couldn't find file 'vue-validator' with type 'application/javascript' -``` - -vue-validator has been changed to vue-validator2 -and vue-validator3. Use `//= require vue-validator2` or `//= require vue-validator3` instead. - -### Sprockets::FileNotFound: couldn't find file 'vuex' - -vuex has been updated to vuex2. Therefore use `//= require vuex2` to resolve the error `Sprockets::FileNotFound: couldn't find file 'vuex'`. - -### You are running Vue in development mode. - -``` - You are running Vue in development mode. - Make sure to turn on production mode when deploying for production. - See more tips at https://vuejs.org/guide/deployment.html -``` - -Try to use `//= require vue2.min` to remove the warning statement from console. - - -## Requirement - -- Rails -- Webpacker -- Vue -- Node -- Webpack - -## Contributing and License - -Bug reports and pull requests are welcome on GitHub at https://github.com/ytbryan/vuejs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/ytbryan/vueonrails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). - -## Book - -Richard LaFranchi and I are writing a book on [Vue on rails](http://vueonrails.com). If you are interested to be one of the early reviewers of our drafts, please email me. - -## Contact - -📮 Bryan Lim ytbryan@gmail.com - -> If you are using Vue.js via this rubygem, do let me know so that I can list your project/company on this repo. Thank you!