README.md in intro-0.3.0 vs README.md in intro-0.4.0

- old
+ new

@@ -19,11 +19,11 @@ ![example](https://user-images.githubusercontent.com/19590194/64253419-dbe38d80-cf4f-11e9-9aab-b1e6058990ab.png) ## Demo -[Demo](https://intro-demo.herokuapp.com/) +[Demo](https://intro-demo.herokuapp.com/): [Source](https://github.com/jinhucheung/intro-demo) ## Installation Add `intro` to application's Gemfile: @@ -44,13 +44,19 @@ ``` Then do migrate: ``` -$ bundle exec rake db:migrate +$ rails db:migrate ``` +Compile assets: + +``` +$ rails assets:precompile +``` + ## Usage ### Inserting assets into view Insert `intro_tags` into common layout, just before the closing body tag: @@ -80,14 +86,23 @@ ``` Then you would get the asset files: ``` -app/assets/stylesheets/intro/shepherd/_variables.scss -app/assets/stylesheets/intro/shepherd/base.scss +app/javascript/stylesheets/intro/_variables.scss +app/javascript/stylesheets/intro/custom.scss +app/javascript/packs/intro/custom.js ``` Change them for your need. + +Last, import custom packs javascript into `intro_tag` like this: + +``` +<%= intro_tags do %> + <%= javascript_pack_tag('intro/custom') %> +<% end %> +``` ### Configuring intro see `config/initializers/intro.rb` for detail configuration. \ No newline at end of file