Permalink
Browse files

Readme updates

  • Loading branch information...
1 parent c88c196 commit 4bdd5bca0551646d37b3ebcc151c71a9494b7164 @sporkd committed Apr 7, 2013
View
@@ -4,8 +4,6 @@ Html5 for Rails
Html5 for Rails projects based on [Html5 Boilerplate](http://html5boilerplate.com)
by Paul Irish, Divya Manian and many other [fine folks](https://github.com/h5bp/html5-boilerplate/contributors).
-(Also, a rewrite of compass-html5-boilerplate that adds Rails asset pipeline integration).
-
Installation
=========================
@@ -16,17 +14,18 @@ group :assets do
gem 'sass-rails'
gem 'coffee-rails'
gem 'uglifier'
- gem 'compass-rails'
+
gem 'compass-h5bp'
end
-# Optional - to generate haml
-#gem 'haml-rails'
-# Optional - to generate slim
-#gem 'slim-rails'
-
gem 'jquery-rails'
gem 'html5-rails'
+
+# Optional: to generate haml
+# gem 'haml-rails'
+
+# Optional: to generate slim
+# gem 'slim-rails'
```
##### 2. Install your bundle
@@ -45,20 +44,21 @@ $ rails generate html5:install
create config/compass.rb
create config/html5_rails.yml
- create app/views/layouts/application.html.erb
+ create app/views/layouts/application.html.(erb|haml|slim)
create app/views/application
- create app/views/application/_footer.html.erb
- create app/views/application/_head.html.erb
- create app/views/application/_header.html.erb
- create app/views/application/_chromeframe.html.erb
+ create app/views/application/_footer.html.(erb|haml|slim)
+ create app/views/application/_head.html.(erb|haml|slim)
+ create app/views/application/_header.html.(erb|haml|slim)
+ create app/views/application/_chromeframe.html.(erb|haml|slim)
+ exist app/assets/javascripts
insert app/assets/javascripts/application.js
gsub app/assets/javascripts/application.js
create app/assets/javascripts/polyfills.js
remove app/assets/stylesheets/application.css
- create app/assets/stylesheets/_variables.css.scss
- create app/assets/stylesheets/application.css.scss
create app/assets/stylesheets/application
- create app/assets/stylesheets/application/document.css.scss
+ create app/assets/stylesheets/application/index.css.scss
+ create app/assets/stylesheets/application/variables.css.scss
+ create app/assets/stylesheets/application/layout.css.scss
create app/assets/stylesheets/application/media_queries.css.scss
##### 4. And you're done!
@@ -77,6 +77,11 @@ $ rails generate html5:partial --help
$ rails generate html5:assets --help
```
+Google Analytics
+=========================
+
+By default your Google Analytics code snippet will be hidden until you set your Google Account ID.
+You can do this by either setting `ENV['GOOGLE_ACCOUNT_ID']` or `google_account_id` in config/html5_rails.yml.
Notes
==========
@@ -85,13 +90,10 @@ Notes
included in your assets group for development and asset precompiling to work.
[2] If you use `--template-engine=haml` (or `haml-rails` gem), the install
-generator will remove your application.html.erb layout so that
+generator will prompt to remove your application.html.erb layout so that
application.html.haml will be used instead.
-[3] If you're upgrading from compass-html5-boilerplate you need to
-remove config/compass.rb before you run the generators.
-
-[4] For the time being, you will want to add the following line to
+[3] For the time being, you will want to add the following line to
config/production.rb so that polyfills are precompiled on deploy:
`config.assets.precompile += %w( polyfills.js )`
@@ -3,7 +3,7 @@
<%# Append your own using content_for :javascripts %>
<%= yield :javascripts %>
-<%# asynchronous google analytics: mathiasbynens.be/notes/async-analytics-snippet %>
+<%# Google Analytics %>
<%# Looks for google_account_id first in ENV['GOOGLE_ACCOUNT_ID'] then in config/html5_rails.yml %>
<% if !google_account_id.blank? %>
<script>
@@ -3,7 +3,7 @@
<%%# Append your own using content_for :javascripts %>
<%%= yield :javascripts %>
-<%%# asynchronous google analytics: mathiasbynens.be/notes/async-analytics-snippet %>
+<%%# Google Analytics %>
<%%# Looks for google_account_id first in ENV['GOOGLE_ACCOUNT_ID'] then in config/html5_rails.yml %>
<%% if !google_account_id.blank? %>
<script>

0 comments on commit 4bdd5bc

Please sign in to comment.