update docs

Author: mitchellhenke

README.md

@@ -105,14 +105,6 @@ current environment_name: :prod
 Sending test event!
 ```
 
-A couple of things to note:
-
-* This won't test your environment configuration. The test CLI forces your
-  configuration to represent itself as if it were running in the production env.
-* If you're running within Rails (or anywhere else that will bootstrap the
-  rake environment), you should be able to omit the DSN argument.
-
-
 ## Docs
 
 To build the docs locally, you'll need the [Sphinx](http://www.sphinx-doc.org/en/stable/):

docs/config.rst

@@ -51,3 +51,30 @@ Optional settings
 
   Set this to true if you want to capture all exceptions that occur even outside of a request cycle. This
   defaults to false.
+
+Testing Your Configuration
+--------------------------
+
+To ensure you've set up your configuration correctly we recommend running the
+included mix task.  It can be tested on different Mix environments and will tell you if it is not currently configured to send events in that environment:
+
+.. code-block:: bash
+  $ MIX_ENV=dev mix sentry.send_test_event
+  Client configuration:
+  server: https://sentry.io/
+  public_key: public
+  secret_key: secret
+  included_environments: [:prod]
+  current environment_name: :dev
+
+  :dev is not in [:prod] so no test event will be sent
+
+  $ MIX_ENV=prod mix sentry.send_test_event
+  Client configuration:
+  server: https://sentry.io/
+  public_key: public
+  secret_key: secret
+  included_environments: [:prod]
+  current environment_name: :prod
+
+  Sending test event!