Add environment_name in the README.md

[phstc]

I would like to suggest to add environment_name info in the README.md. For me the README and even in the Project Settings in http://honeybadger.io seem to be only focused on Rails, Sinatra and Rack apps. In my case, I'm using it in a standalone ruby application.

Honeybadger.configure do |config|
  config.development_environments << 'staging'
  config.environment_name = ENV['MY_SPECIFIC_SERVER_ENV']
  config.api_key = '...'
end

I had to investigate the source code to check how to define the environment name which is used in development_environments. It wasn't hard, but in my point of view, it could be in the README. I believe that most of the users use Rails, Sinatra or Rack, but some don't.

I also recommend to use the same nomenclature in the README as used in the website. The website has references to Private API Key, in the README it is only API Key, although it can be understandable, sometimes it can lead a confusion. Specially in some cases that you can't test it right now. The README has also some sample API Keys 1234567890abcdef, which are bigger than the Private API Keys used in the website a1aa1111.

[phstc]

The same for the context, standalone applications don't have traditional request life cycle. A mention that you can specify the context for notifications without being global (for some life cycle) would be useful.

Honeybadger.notify e, { context: { my_context_key1: 'my key persisted only for this notification' } }

The README has only the global one.

Honeybadger.context { ... }

The Honeybadger.context for standalone applications can be dangerous, since it will not change automatically.

[joshuap]

Hi Pablo, you're absolutely right - we do need better documentation on those features (and a few others, I'm sure). I would gladly accept pull requests with improved documentation if you feel inclined to pitch in, otherwise I'll be working on this over the next month or so. Thanks for reporting - let me know if you find anything else!

[joshuap]

I've added this to our internal issue tracker since the gem documentation has now been moved here. Thanks!

[phstc]

@joshuap nice, thanks! 😄