frontend-helpers 0.0.1.beta.1 → 0.0.2

data/README.md

@@ -1,6 +1,9 @@
 # Frontend Helpers #
 
-This is a collection of Rails 3.1 Helpers that I have compiled together into one nice neat special little gem... it'll handle doing things such as Meta tag creation, Facebook Open Graph Tag Creation, javascript integration for, Google Analytics, Chartbeat, Inspectlet, Mixpanel, Woopra, Kissmetrics, Quantcast, and Olark, as well I've packaged in a few of my favorite/most used javascript libraries for building amazing web apps, and last but not least, added a great `reset.css.sass` file that goes really nicely with my `variables.css.sass` file, for a basic clean view.
+HARD DEPENDENCY: HAML & SASS
+I do plan on making it work for both ERB & HAML but currently all my projects use both, so I haven't found the time to add this option.
+
+This is a collection of Rails 3.1 Helpers that I have compiled together into one nice neat special little gem... it'll handle doing things such as a few HTML5 helpers, Meta tag creation, Facebook Open Graph Tag Creation, javascript integration for, Google Analytics, Chartbeat, Inspectlet, Mixpanel, Woopra, Kissmetrics, Quantcast, and Olark, as well I've packaged in a few of my favorite/most used javascript libraries for building amazing web apps, and last but not least, added a great `reset.css.sass` file that goes really nicely with my `variables.css.sass` file, for a basic clean view.
 
 Try it on your next project, I'm sure you'll like it.
 
@@ -24,6 +27,18 @@ This should come up and tell you that it's copying `config/settings.yml`, `confi
 
 Then you can start editing them:
 
+
+### HTML5 ###
+
+before you use the HTML5 HTML tag as Paul Irish wrote for the HTML5 Boilerplate `application_controller.rb` add:
+
+    include FrontendHelpers::Html5Helper
+
+Then in your application.html.haml instead of using `%html` use
+
+    - html_tag class: 'no-js' do
+
+
 ### Settings.yml ###
 
 Before you start adding your content to the `settings.yml` you should probably start by including the helper in your `application_controller.rb` add:
@@ -42,7 +57,7 @@ Say for instance you set the key `title`
 
     :title: "Chris Hein's Site"
 
-And on the homepage you liked that, but maybe on the about page you would like it to say `About Chris Hein` with this plugin that's really simple, in your action for your about page simple add:
+And on the homepage you liked that, but maybe on the about page you would like it to say `About Chris Hein` with this plugin that's really simple, in your action for your about page simple add an instance variable as so:
 
     @meta_title = "About Chris Hein"
 
@@ -71,14 +86,60 @@ This will overwrite the current title with whatever you'd like. This is the list
     :"og:country_name" => @meta_og_country_name,
     :"og:phone_number" => @meta_og_phone_number
 
+
 ### Services.yml ###
 
-TODO: Write how to use this
+Before you start adding your content to the `services.yml` you should probably start by including the helper in your `application_controller.rb` add:
+
+    include FrontendHelpers::ServicesHelper
+
+Next where ever you want the services javascript to appear (I'd recommend using it at the end of the body) use:
+
+    - webservice [:google, :olark, :chartbeat, :inspectlet, :mixpanel, :woopra, :kissmetrics, :quantcast]
+
+This example shows all of the services that can be included although you will not see any of them unless you have added the necessary information in the `services.yml` you can remove any of them from the array if need be.
+
+Inside the `services.yml` you will find all of variables that should be set to use each one of the services. All of them are pretty self explanatory and the keys can be gotten from each service.
 
 
 ### Assets ###
 
-TODO: Write how to use this
+As far as the assets I've added a few of my favorite and most used javascript libraries, those are:
+
+[Backbone](http://documentcloud.github.com/backbone/)
+[Underscore](http://documentcloud.github.com/underscore/)
+[DD Belated PNG](http://www.dillerdesign.com/experiment/DD_belatedPNG/)
+[jQuery Asynchronous Plugin](http://mess.genezys.net/jquery/jquery.async.php)
+[jQuery Cookie plugin](https://github.com/carhartl/jquery-cookie)
+[jQuery Lifestream](https://github.com/christianv/jquery-lifestream)
+[jQuery Validation](http://bassistance.de/jquery-plugins/jquery-plugin-validation/)
+[Log Helper](http://html5boilerplate.com)
+[Modernizr](http://www.modernizr.com/)
+[Shortcut JS](http://www.openjs.com/scripts/events/keyboard_shortcuts/)
+[SWF Object](http://code.google.com/p/swfobject/)
+
+All of these can be added to your manifest file for Sprockets like this
+
+    //= require backbone
+    //= require ie
+    //= require jquery.async
+    //= require jquery.cookie
+    //= require jquery.lifestream
+    //= require jquery.vaidate
+    //= require log
+    //= require modernizr
+    //= require shortcut
+    //= require swfobject
+
+Not only did I add a bunch of wonderfully awesome javascript libs I also added a css reset that can be used, as well as a base variables... Although with sprockets currently you cannot include files with persistent variables, so I would highly recommend using SASS's built in `@import` to include files to do so include both files like so rename `application.css` to `application.css.sass` then add:
+
+    @import "variables.css.sass"
+    @import "reset.css.sass"
+
+
+## Thanks ##
+
+I hope you enjoy using this Rubygem, if you have any questions, issues, or feature requests please make them in the issues section, I'll be continually adding to this so please keep checking in on the progress.
 
 
 ## Contributing to Frontend Helpers ##
@@ -95,3 +156,5 @@ TODO: Write how to use this
 
 Copyright (c) 2011 Christopher Hein. See LICENSE.txt for
 further details.
+
+All javascript libraries are still copyrighted to their respective owners, this is just a way to easy add them to any project without having to deal with the files themselves.

data/Rakefile

@@ -19,7 +19,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Large collection of useful Rails 3.1 helpers for SEO, Metatags, Facebook OG tags, integration for analytics services like google, woopra, olark, mixpanel and much much more...}
   gem.email = "me@christopherhein.com"
   gem.authors = ["Christopher Hein"]
-  gem.version = "0.0.1.beta.1"
+  gem.version = "0.0.2"
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/frontend-helpers.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{frontend-helpers}
-  s.version = "0.0.1.beta.1"
+  s.version = "0.0.2"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christopher Hein"]
-  s.date = %q{2011-07-10}
+  s.date = %q{2011-07-11}
   s.description = %q{Large collection of useful Rails 3.1 helpers for SEO, Metatags, Facebook OG tags, integration for analytics services like google, woopra, olark, mixpanel and much much more...}
   s.email = %q{me@christopherhein.com}
   s.extra_rdoc_files = [

metadata

@@ -1,20 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: frontend-helpers
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta.1
-  prerelease: 6
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Christopher Hein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-10 00:00:00.000000000 -07:00
+date: 2011-07-11 00:00:00.000000000 -07:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2160497800 !ruby/object:Gem::Requirement
+  requirement: &2170509820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 3.1.0.rc4
   type: :runtime
   prerelease: false
-  version_requirements: *2160497800
+  version_requirements: *2170509820
 - !ruby/object:Gem::Dependency
   name: haml-rails
-  requirement: &2160496080 !ruby/object:Gem::Requirement
+  requirement: &2170690020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160496080
+  version_requirements: *2170690020
 - !ruby/object:Gem::Dependency
   name: sass-rails
-  requirement: &2160495040 !ruby/object:Gem::Requirement
+  requirement: &2170726200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 3.1.0.rc
   type: :runtime
   prerelease: false
-  version_requirements: *2160495040
+  version_requirements: *2170726200
 - !ruby/object:Gem::Dependency
   name: sprockets
-  requirement: &2160494400 !ruby/object:Gem::Requirement
+  requirement: &2170728960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.0.0.beta.10
   type: :runtime
   prerelease: false
-  version_requirements: *2160494400
+  version_requirements: *2170728960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2160493260 !ruby/object:Gem::Requirement
+  requirement: &2170737720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +66,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *2160493260
+  version_requirements: *2170737720
 description: Large collection of useful Rails 3.1 helpers for SEO, Metatags, Facebook
   OG tags, integration for analytics services like google, woopra, olark, mixpanel
   and much much more...
@@ -159,13 +159,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3543253954648120841
+      hash: 1927932755556081879
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.6.2