Add a configuration section to the README (#170)

DominicKramer · web-flow · commit 71665343c251 · 2016-11-02T10:19:33.000-07:00
This PR adds a configuration section to the README file that should have been added in PR #167.
diff --git a/README.md b/README.md
@@ -20,8 +20,8 @@ This module provides Stackdriver Debugger support for Node.js applications. [Sta
 # Install with `npm` or add to your `package.json`.
 npm install --save @google/cloud-debug
 
-# Require the agent at the top of your main script (but after '@google/cloud-trace' if you are also using it).
-require('@google/cloud-debug');
+# Require and start the agent at the top of your main script (but after '@google/cloud-trace' if you are also using it).
+require('@google/cloud-debug').start();
 ```
 Deploy your application, and navigate to the [Stackdriver Debug view][debug-tab] within the [Google Cloud Console][dev-console] to set snapshots and start debugging.
 
@@ -65,6 +65,18 @@ If your application is running outside of Google Cloud Platform, such as locally
 
         gcloud app gen-repo-info-file
 
+## Configuration
+
+See [the default configuration](config.js) for a list of possible configuration options. These options can be passed to the agent through the object argument to the start command as shown below:
+
+        require('@google/cloud-debug').start({
+          logLevel: 2,
+          serviceContext: {
+              service: 'my-service',
+              version: '1'
+            }
+        });
+
 ## Using the Debugger
 
 Once your application is running (deployed, or elsewhere), you should be able to use the [Debug UI][debug-tab] in your Cloud [developer console][dev-console]. You can find the Debug UI in the 'STACKDRIVER -> Debug' section in the navigation panel, or by simply searching for 'Debug' in the cloud console.
diff --git a/config.js b/config.js
@@ -24,6 +24,14 @@ module.exports = {
     // An identifier for the current code deployment.
     description: undefined,
 
+    serviceContext: {
+      // An identifier for the deployed application's service name
+      service: undefined,
+
+      // An identifier for the deployed application's version
+      version: undefined
+    },
+
     // The path within your repository to the directory containing the
     // package.json for your deployed application. This should be provided
     // if your deployed application appears as a subdirectory of your repository.
