refac: update readme and better access token handling

Author: atran

tags-transformer/README.md

@@ -1,25 +1,26 @@
-# Rollbar PHP Examples: LaunchDarklyTransformer
+# Rollbar PHP Examples: TagsTransformer
 
-This project is an example of how to set up a custom transformer for Rollbar
-reporting for your PHP application. We use this functionality to move the extra
-data sent with the payload to the root level under the `tags` object.
-
-## Installation
-
-1. `cp config/secret.example.php config/secret.php`
-2. Fill out `config/secret.php` with your Rollbar server-side access token.
+This project is an example of how to set up a custom transformer to modify the payload sent by the PHP SDK to match
+what is expected from our beta LaunchDarkly integration. The integration is expecting the feature flag key to be sent
+as a tag object in the `tags` section of the payload. By following this example, you should be able to do just that.
 
 ## Steps used in this example
 1. Set up `rollbar/rollbar` as a dependency with `composer require rollbar/rollbar`.
 2a. Create your transformer class in `src/TagsTransformer.php` which implements `TransformerInterface`.
 2b. Create your data class which implements `Data` (is found in `src/TagsTransformer.php`).
 3. Implement `transform` method in your `TagsTransformer` with desired business logic. Make sure you return the $payload object from this method.
 4. Set up Rollbar with your `TagsTransformer` class in `example.php` using `transformer` configuration option.
-5. Run `composer test` and verify that the extra data is sent under the `tags` key in Rollbar.
+5. Set your API token into the environment.
+  On Mac/Linux/UNIX, try `export ROLLBAR_TOKEN=the-access-token`.
+  On Windows CMD, use set `ROLLBAR_TOKEN="the-access-token"`.
+  For Windows PowerShell, use `$env:ROLLBAR_TOKEN="the-access-token"`.
+6. Run `composer test` and verify that the extra data is sent under the `tags` key in Rollbar.
 
 ## Help / Support
 
 If you run into any issues, please email us at [support@rollbar.com](mailto:support@rollbar.com)
 
 ## Testing
-To run the example: `composer test`
+To run the example:
+Make sure to set your Rollbar API access token in the ROLLBAR_TOKEN environment variable in step 5.
+And then run: `composer test`.

tags-transformer/config/secret.example.php

@@ -7,7 +7,7 @@
 use Rollbar\Payload\Level;
 
 $config = array(
-    'access_token' => $_SECRET['access_token'],
+    'access_token' => $_ENV['ROLLBAR_TOKEN'],
     'environment' => 'local',
     /**
      * 4. Set up Rollbar with your `TagsTransformer` class in `example.php`.