Merge pull request #483 from cirdes/master

Javascript notifications on README

Merge pull request #483 from cirdes/master
Javascript notifications on README
Cyril Mougel
2 parents a08862c4 204679d6
Showing 1 changed file with 14 additions and 0 deletions Show diff stats
README.md
@@ -351,6 +351,20 @@ it will be displayed under the *User Details* tab:
  
 (This tab will be hidden if no user information is available.)
  
+Adding javascript errors notifications
+--------------------------------------
+
+Errbit easily supports javascript errors notifications. You just need to add `config.js_notifier = true` to the errbit initializer in the rails app.
+
+```
+Errbit.configure do |config|
+  config.host    = 'YOUR-ERRBIT-HOST'
+  config.api_key = 'YOUR-PROJECT-API-KEY'
+  config.js_notifier = true
+end
+```
+
+Then get the `notifier.js` from `errbit/public/javascript/notifier.js` and add to `application.js` on your rails app or inlcude `http://YOUR-ERRBIT-HOST/javascripts/notifier.js` on your `application.html.erb.`
  
 Issue Trackers
 --------------
...	...	@@ -351,6 +351,20 @@ it will be displayed under the User Details tab:
351	351
352	352	(This tab will be hidden if no user information is available.)
353	353
	354	+Adding javascript errors notifications
	355	+--------------------------------------
	356	+
	357	+Errbit easily supports javascript errors notifications. You just need to add `config.js_notifier = true` to the errbit initializer in the rails app.
	358	+
	359	+```
	360	+Errbit.configure do \|config\|
	361	+ config.host = 'YOUR-ERRBIT-HOST'
	362	+ config.api_key = 'YOUR-PROJECT-API-KEY'
	363	+ config.js_notifier = true
	364	+end
	365	+```
	366	+
	367	+Then get the `notifier.js` from `errbit/public/javascript/notifier.js` and add to `application.js` on your rails app or inlcude `http://YOUR-ERRBIT-HOST/javascripts/notifier.js` on your `application.html.erb.`
354	368
355	369	Issue Trackers
356	370	--------------
...	...