Download as
Browse Code »

Commit 514633bf6e0da84d719c1671b4f30f32dd93b179

Authored by Stephen Crosby
2 parents 4678fd1d 440cd375
Exists in master and in 1 other branch production

Merge pull request #690 from tomciopp/patch-1 

Update README.md
Showing 1 changed file with 39 additions and 38 deletions   Show diff stats
README.md
  Diff comments   View file @514633b
... ... @@ -78,25 +78,20 @@ There is a demo available at [http://errbit-demo.herokuapp.com/](http://errbit-d
78 78 Email: demo@errbit-demo.herokuapp.com<br/>
79 79 Password: password
80 80  
81   -# Requirement
  81 +# Requirements
82 82  
83   -The list of requirement to install Errbit is :
  83 +The list of requirements to install Errbit are :
84 84  
85 85 * Ruby 1.9.3 or higher
86 86 * MongoDB 2.2.0 or higher
87 87  
88   -By default it's the Ruby 2.0.0 to use. But you can define your own ruby
89   -version with RUBY_VERSION variable between :
90   -
91   - * 1.9.3
92   - * 2.0.0
93   - * 2.1.0
  88 +Errbit uses Ruby 2.0.0 as a default. However, it is compatible with Ruby 1.9.3 and above.
94 89  
95 90 Installation
96 91 ------------
97 92  
98 93 *Note*: This app is intended for people with experience deploying and maintaining
99   -Rails applications. If you're uncomfortable with any step below then Errbit is not
  94 +Rails applications. If you're uncomfortable with any steps below then Errbit is not
100 95 for you.
101 96  
102 97 **Set up your local box or server(Ubuntu):**
... ... @@ -357,17 +352,16 @@ rake db:migrate
357 352 rake assets:precompile
358 353 ```
359 354  
360   -If we change the way that data is stored, this will run any migrations to bring your database up to date.
  355 +This will ensure that your application stays up to date with any schema changes.
361 356  
362 357  
363   -### Upgrade from errbit 0.2 to 0.3
  358 +### Upgrading errbit from version 0.2 to 0.3
364 359  
365   -The file of MongoDB connection config/mongoid.yml change between 0.2 to
366   -0.3. So Check the new config/mongoid.yml.example file and update it in
367   -good way.
  360 +The MongoDB connection file `config/mongoid.yml` has changed between version 0.2 and
  361 +0.3. We have provided a new example configuration file to use at `config/mongoid.example.yml`.
368 362  
369   -This change is not need to be done if you use only ENV variable to
370   -define you access to MongoDB database.
  363 +This change is not needed if you use ENV variables to
  364 +define access to your MongoDB database.
371 365  
372 366  
373 367 ## User information in error reports
... ... @@ -376,11 +370,12 @@ Errbit can now display information about the user who experienced an error.
376 370 This gives you the ability to ask the user for more information,
377 371 and let them know when you've fixed the bug.
378 372  
379   -If you would like to include information about the current user in your error reports,
380   -you can replace the `airbrake` gem in your Gemfile with `airbrake_user_attributes`,
381   -which wraps the `airbrake` gem and injects user information.
382   -It will inject information about the current user into the error report
383   -if your Rails app's controller responds to a `#current_user` method.
  373 +If you are running a Rails application and would like to include information
  374 +about the current user in your error reports, you can replace the `airbrake`
  375 +gem in your Gemfile with `airbrake_user_attributes`.
  376 +This gem is a wrapper around the `airbrake` gem and will automatically
  377 +inject information about the user into any error reports,
  378 +so long as your controllers respond to a `#current_user` method.
384 379 The user's attributes are filtered to remove authentication fields.
385 380  
386 381 If user information is received with an error report,
... ... @@ -391,26 +386,33 @@ it will be displayed under the *User Details* tab:
391 386  
392 387 (This tab will be hidden if no user information is available.)
393 388  
394   -Adding javascript errors notifications
  389 +Javascript error notifications
395 390 --------------------------------------
396 391  
397   -Errbit easily supports javascript errors notifications. You just need to add `config.js_notifier = true` to the errbit initializer in the rails app.
  392 +You can log javascript errors that occur in your application by following the directions below.
  393 +
  394 +# Rails Applications
  395 +
  396 +Add the following line to the `<head>` section of your application template.
  397 +
  398 +```
  399 +<%= airbrake_javascript_notifier %>
  400 +```
  401 +
  402 +# Other Platforms
  403 +
  404 +include the following before any javascript is loaded in your application.
398 405  
399 406 ```
400   -Errbit.configure do |config|
401   - config.host = 'YOUR-ERRBIT-HOST'
402   - config.api_key = 'YOUR-PROJECT-API-KEY'
403   - config.js_notifier = true
404   -end
  407 +<script src='http://YOUR-ERRBIT-HOST/javascripts/notifier.js' type='text/javascript'></script>
405 408 ```
406 409  
407   -Then get the `notifier.js` from `errbit/public/javascript/notifier.js` and add to `application.js` on your rails app or include `http://YOUR-ERRBIT-HOST/javascripts/notifier.js` on your `application.html.erb.`
408 410  
409 411 Using custom fingerprinting methods
410 412 -----------------------------------
411 413  
412   -Errbit now allows you to easily use your own Fingerprint Strategy if that's what you'd like to do. If you are upgrading from a very old version of errbit, you can use the `LegacyFingerprint` to provide yourself
413   -with compatibility. The fingerprint strategy can be changed by adding an initializer to errbit:
  414 +Errbit allows you to use your own Fingerprinting Strategy.
  415 +If you are upgrading from a very old version of errbit, you can use the `LegacyFingerprint` for compatibility. The fingerprint strategy can be changed by adding an initializer to errbit:
414 416  
415 417 ```ruby
416 418 # config/fingerprint.rb
... ... @@ -542,11 +544,6 @@ Solutions known to work are listed below:
542 544 </tr>
543 545 </table>
544 546  
545   -Develop on Errbit
546   ------------------
547   -
548   -A guide can help on this way on [**Errbit Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md)
549   -
550 547 ## Other documentation
551 548  
552 549 * [All ENV variables availables to configure Errbit](docs/ENV-VARIABLES.md)
... ... @@ -579,7 +576,7 @@ Special Thanks
579 576 See the [contributors graph](https://github.com/errbit/errbit/graphs/contributors) for further details. You can see another list of Contributors by release version on [CONTRIBUTORS.md]
580 577  
581 578  
582   -Contributing
  579 +Contributing to Errbit
583 580 ------------
584 581  
585 582 We welcome any contributions. If you need to tweak Errbit for your organization's needs,
... ... @@ -601,9 +598,13 @@ and make **optional** features configurable via `config/config.yml`.
601 598 * Send us a pull request. Bonus points for topic branches.
602 599 * Add you on the CONTRIBUTORS.md file on the current release
603 600  
  601 +# Running tests
  602 +
  603 +More information can be found in the [**Errbit Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md)
  604 +
604 605  
605 606 Copyright
606 607 ---------
607 608  
608   -Copyright (c) 2010-2013 Errbit Team. See LICENSE for details.
  609 +Copyright (c) 2010-2014 Errbit Team. See LICENSE for details.
609 610  
... ...