Commit fbefa9c0749c5545eee147f2bf64d41e35041589
1 parent
0dd93073
Exists in
master
and in
1 other branch
Updated User info section in README
Showing
1 changed file
with
11 additions
and
8 deletions
Show diff stats
README.md
| ... | ... | @@ -208,19 +208,22 @@ If we change the way that data is stored, this will run any migrations to bring |
| 208 | 208 | User information in error reports |
| 209 | 209 | ----------------------------- |
| 210 | 210 | |
| 211 | -Errbit can display information about the user who experienced the error, | |
| 212 | -which gives you the ability to ask your users for more information, | |
| 213 | -or notify them when the bug is fixed. | |
| 211 | +Errbit can now display information about the user who experienced an error. | |
| 212 | +This gives you the ability to ask the user for more information, | |
| 213 | +and let them know when you've fixed the bug. | |
| 214 | 214 | |
| 215 | 215 | If you would like to include information about the current user in your error reports, |
| 216 | -you can replace the `airbrake` gem in your `Gemfile` with the `airbrake_user_attributes` gem. | |
| 217 | -This gem is a wrapper around the `airbrake` gem. It will inject information about the current user into the error report, | |
| 216 | +you can replace the `airbrake` gem in your Gemfile with `airbrake_user_attributes`, | |
| 217 | +which wraps the `airbrake` gem and injects user information. | |
| 218 | +It will inject information about the current user into the error report | |
| 218 | 219 | if your Rails app's controller responds to a `#current_user` method. |
| 219 | -The user attributes are filtered, so that no authentication-related fields are included. | |
| 220 | +The user's attributes are filtered to remove authentication fields. | |
| 220 | 221 | |
| 221 | -Whenever user information is received with an error report, it will displayed under the **User Details** tab: | |
| 222 | +If user information is received with an error report, | |
| 223 | +it will displayed under the *User Details* tab: | |
| 222 | 224 | |
| 223 | - | |
| 225 | + | |
| 226 | + | |
| 224 | 227 | |
| 225 | 228 | (This tab will be hidden if no user information is available.) |
| 226 | 229 | ... | ... |