Download as
Browse Code »

Commit 4cd3fc46b886c9582f61b3dda8aaa2d3b92066b4

Authored by Thomas Cioppettini
1 parent 78c34e2f
Exists in master and in 1 other branch production

Update README.md

Showing 1 changed file with 41 additions and 37 deletions   Show diff stats
README.md
  Diff comments   View file @4cd3fc4
... ... @@ -78,25 +78,21 @@ 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.
  89 +To use a different version of ruby, override the `RUBY_VERSION` constant with the version you are using.
94 90  
95 91 Installation
96 92 ------------
97 93  
98 94 *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
  95 +Rails applications. If you're uncomfortable with any steps below then Errbit is not
100 96 for you.
101 97  
102 98 **Set up your local box or server(Ubuntu):**
... ... @@ -360,17 +356,16 @@ rake db:migrate
360 356 rake assets:precompile
361 357 ```
362 358  
363   -If we change the way that data is stored, this will run any migrations to bring your database up to date.
  359 +This will ensure that your application stays up to date with any schema changes.
364 360  
365 361  
366   -### Upgrade from errbit 0.2 to 0.3
  362 +### Upgrading errbit from version 0.2 to 0.3
367 363  
368   -The file of MongoDB connection config/mongoid.yml change between 0.2 to
369   -0.3. So Check the new config/mongoid.yml.example file and update it in
370   -good way.
  364 +The MongoDB connection file `config/mongoid.yml` has changed between version 0.2 and
  365 +0.3. We have provided a new example configuration file to use at `config/mongoid.example.yml`.
371 366  
372   -This change is not need to be done if you use only ENV variable to
373   -define you access to MongoDB database.
  367 +This change is not needed if you use ENV variables to
  368 +define access to your MongoDB database.
374 369  
375 370  
376 371 ## User information in error reports
... ... @@ -379,11 +374,12 @@ Errbit can now display information about the user who experienced an error.
379 374 This gives you the ability to ask the user for more information,
380 375 and let them know when you've fixed the bug.
381 376  
382   -If you would like to include information about the current user in your error reports,
383   -you can replace the `airbrake` gem in your Gemfile with `airbrake_user_attributes`,
384   -which wraps the `airbrake` gem and injects user information.
385   -It will inject information about the current user into the error report
386   -if your Rails app's controller responds to a `#current_user` method.
  377 +If you are running a Rails application and would like to include information
  378 +about the current user in your error reports, you can replace the `airbrake`
  379 +gem in your Gemfile with `airbrake_user_attributes`.
  380 +This gem is a wrapper around the `airbrake` gem and will automatically
  381 +inject information about the user into any error reports,
  382 +so long as your controllers respond to a `#current_user` method.
387 383 The user's attributes are filtered to remove authentication fields.
388 384  
389 385 If user information is received with an error report,
... ... @@ -394,26 +390,34 @@ it will be displayed under the *User Details* tab:
394 390  
395 391 (This tab will be hidden if no user information is available.)
396 392  
397   -Adding javascript errors notifications
  393 +Javascript error notifications
398 394 --------------------------------------
399 395  
400   -Errbit easily supports javascript errors notifications. You just need to add `config.js_notifier = true` to the errbit initializer in the rails app.
  396 +You can log javascript errors that occur in your application by following the directions below.
  397 +
  398 +# Rails Applications
  399 +
  400 +Add the following line to the `<head>` section of your application template.
  401 +
  402 +```
  403 +<%= airbrake_javascript_notifier %>
  404 +```
  405 +
  406 +# Other Platforms
  407 +
  408 +
  409 +include the following before any javascript is loaded in your application.
401 410  
402 411 ```
403   -Errbit.configure do |config|
404   - config.host = 'YOUR-ERRBIT-HOST'
405   - config.api_key = 'YOUR-PROJECT-API-KEY'
406   - config.js_notifier = true
407   -end
  412 +<script src='http://YOUR-ERRBIT-HOST/javascripts/notifier.js' type='text/javascript'></script>
408 413 ```
409 414  
410   -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.`
411 415  
412 416 Using custom fingerprinting methods
413 417 -----------------------------------
414 418  
415   -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
416   -with compatibility. The fingerprint strategy can be changed by adding an initializer to errbit:
  419 +Errbit allows you to use your own Fingerprinting Strategy.
  420 +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:
417 421  
418 422 ```ruby
419 423 # config/fingerprint.rb
... ... @@ -545,11 +549,6 @@ Solutions known to work are listed below:
545 549 </tr>
546 550 </table>
547 551  
548   -Develop on Errbit
549   ------------------
550   -
551   -A guide can help on this way on [**Errbit Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md)
552   -
553 552 ## Other documentation
554 553  
555 554 * [All ENV variables availables to configure Errbit](docs/ENV-VARIABLES.md)
... ... @@ -582,7 +581,7 @@ Special Thanks
582 581 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]
583 582  
584 583  
585   -Contributing
  584 +Contributing to Errbit
586 585 ------------
587 586  
588 587 We welcome any contributions. If you need to tweak Errbit for your organization's needs,
... ... @@ -603,6 +602,11 @@ and make **optional** features configurable via `config/config.yml`.
603 602 * Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself we can ignore when we pull)
604 603 * Send us a pull request. Bonus points for topic branches.
605 604 * Add you on the CONTRIBUTORS.md file on the current release
  605 +*
  606 +
  607 +# Running tests
  608 +
  609 +More information can be found in the [**Errbit Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md)
606 610  
607 611  
608 612 Copyright
... ...