Merge pull request #59 from ukd1/patch-1

Make the docs nicer, fix typo

Author: erskingardner

README.md

@@ -20,8 +20,10 @@ Using bundler:
 
 ### Configure your access credentials
 
-    Intercom.app_id = "my_app_iddd"
-    Intercom.api_key = "my-super-crazy-api-key"
+```ruby
+Intercom.app_id = "my_app_id"
+Intercom.api_key = "my-super-crazy-api-key"
+```
 
 ### Resources
 
@@ -35,44 +37,55 @@ The API supports:
 ### Examples
 
 #### Users
-    user = Intercom::User.find_by_email("[email protected]")
-    user.custom_data["average_monthly_spend"] = 1234.56
-    user.save
-    user = Intercom::User.find_by_user_id("[email protected]")
-    user = Intercom::User.create(:email => "[email protected]", :name => "Bob Smith")
-    user = Intercom::User.new(params)
-    user.save
-    Intercom::User.all.count
-    Intercom::User.all.each {|user| puts %Q(#{user.email} - #{user.custom_data["average_monthly_spend"]}) }
-    Intercom::User.all.map {|user| user.email }
+
+```ruby
+user = Intercom::User.find_by_email("[email protected]")
+user.custom_data["average_monthly_spend"] = 1234.56
+user.save
+user = Intercom::User.find_by_user_id("[email protected]")
+user = Intercom::User.create(:email => "[email protected]", :name => "Bob Smith")
+user = Intercom::User.new(params)
+user.save
+Intercom::User.all.count
+Intercom::User.all.each {|user| puts %Q(#{user.email} - #{user.custom_data["average_monthly_spend"]}) }
+Intercom::User.all.map {|user| user.email }
+```
 
 #### Companies
-    user = Intercom::User.find_by_email("[email protected]")
-    user.company = {:id => 6, :name => "Intercom"}
-    user.companies = [{:id => 6, :name => "Intercom"}, {:id => 9, :name => "Test Company"}]
+```ruby
+user = Intercom::User.find_by_email("[email protected]")
+user.company = {:id => 6, :name => "Intercom"}
+user.companies = [{:id => 6, :name => "Intercom"}, {:id => 9, :name => "Test Company"}]
+```
 
 You can also pass custom data within a company:
 
-    user.company = {:id => 6, :name => "Intercom", :referral_source => "Google"}
+```ruby
+user.company = {:id => 6, :name => "Intercom", :referral_source => "Google"}
+```
 
 #### Message Threads
-
-    Intercom::MessageThread.create(:email => "[email protected]", :body => "Example message from [email protected] to your application on Intercom.")
-    Intercom::MessageThread.find(:email => "[email protected]", :thread_id => 123)
-    Intercom::MessageThread.find_all(:email => "[email protected]")
-    Intercom::MessageThread.mark_as_read(:email => "[email protected]", :thread_id => 123)
+```ruby
+Intercom::MessageThread.create(:email => "[email protected]", :body => "Example message from [email protected] to your application on Intercom.")
+Intercom::MessageThread.find(:email => "[email protected]", :thread_id => 123)
+Intercom::MessageThread.find_all(:email => "[email protected]")
+Intercom::MessageThread.mark_as_read(:email => "[email protected]", :thread_id => 123)
+```
 
 #### Impressions
-
-    Intercom::Impression.create(:email => "[email protected]", :location => "/path/in/my/app", :user_ip => "1.2.3.4", :user_agent => "my-savage-iphone-app-0.1"
+```ruby
+Intercom::Impression.create(:email => "[email protected]", :location => "/path/in/my/app", :user_ip => "1.2.3.4", :user_agent => "my-savage-iphone-app-0.1"
+```
 
 #### Notes
-
-    Intercom::Note.create(:email => "[email protected]", :body => "This is the text of the note")
+```ruby
+Intercom::Note.create(:email => "[email protected]", :body => "This is the text of the note")
+```
 
 ### Errors
-
-    Intercom::AuthenticationError
-    Intercom::ServerError
-    Intercom::ServiceUnavailableError
-    Intercom::ResourceNotFound
+```ruby
+Intercom::AuthenticationError
+Intercom::ServerError
+Intercom::ServiceUnavailableError
+Intercom::ResourceNotFound
+```