Contents

# BugHerd gem

Add the BugHerd widget to your Rails site. [Get a BugHerd account](http://www.bugherd.com/).

## Installation

Add the following to your `Gemfile`:

```ruby
gem "bugherd"
```

...and then run bundle.

Add a file `config/initializers/bugherd.rb` containing:

```ruby
BugHerd.configure do |config|
  config.project_key = 'YOUR KEY HERE'
end
```

Alternatively you can set an environment variable called BUGHERD_PROJECT_KEY.

You can obtain the project key from your project's installation options in BugHerd.

Now add to the *head* tag in your layout(s):

```ruby
<%= bugherd_tag %>
```

## Meta data

BugHerd allows you to pass in extra data which will be added as metadata to any bug your users may log on the page where the widget is rendered.

```ruby
<%= bugherd_tag :metadata => {
  :user_id => current_user.id.to_s,
  :controller => controller.controller_name
} %>
```

## Translation

If you are using the public "Send Feedback" option on your project, you can customise the display text:

```ruby
<%= bugherd_tag :feedback => {
  :tab_text => "Stuur commentaar",
  :option_title_text => "Kies een optie",
  :option_pin_text => "Ik wil graag iets op deze pagina aanwijzen.",
  :option_site_text => "Ik heb commentaar over deze pagina in z'n geheel.",
  :feedback_entry_placeholder => "schrijf hier uw commentaar",
  :feedback_email_placeholder => "uw email adres",
  :feedback_submit_text => "verstuur commentaar",
  :confirm_success_text => "Commentaar is verstuurd.",
  :confirm_loading_text => "Commentaar wordt verstuurd...",
  :confirm_close_text => "sluiten",
  :confirm_error_text => "Er is een fout opgetreden en commentaar kon niet verstuurd worden.",
  :confirm_retry_text => "Probeer opnieuw",
} %>
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
bugherd-0.0.3	README.md