Skip to content
This repository has been archived by the owner on Apr 3, 2024. It is now read-only.

Update README markdown #219

Merged
merged 1 commit into from
Jan 17, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,19 @@ If your application is running outside of Google Cloud Platform, such as locally

1. You will need to specify your project name. Your project name is visible in the [Google Cloud Console][cloud-console-projects], it may be something like `particular-future-12345`. If your application is [running on Google Cloud Platform](running-on-google-cloud-platform), you don't need to specify the project name. You can specify this either in the module options, or through an environment variable:

```js
// In your app:
var debug = require('@google-cloud/debug')({
projectId: 'particular-future-12345',
keyFilename: '/path/to/keyfile.json'
});
debug.startAgent();
```

```bash
# Or in Bash:
export GCLOUD_PROJECT=<project name>
```
```JS
// In your app:
var debug = require('@google-cloud/debug')({
projectId: 'particular-future-12345',
keyFilename: '/path/to/keyfile.json'
});
debug.startAgent();
```

```BASH
# Or in Bash:
export GCLOUD_PROJECT=<project name>
```

1. You need to provide service account credentials to your application.
* The recommended way is via [Application Default Credentials][app-default-credentials].
Expand Down Expand Up @@ -92,15 +92,15 @@ If your application is running outside of Google Cloud Platform, such as locally

You can customize the behaviour of the automatic debugger agent. See [the agent configuration][config-js] for a list of possible configuration options. These options can be passed to the agent through the object argument to the startAgent method as shown below:

```js
debug.startAgent({
serviceContext: {
service: 'my-service',
version: 'version-1'
},
capture: { maxFramesFrames: 20, maxProperties: 100 }
});
```
```JS
debug.startAgent({
serviceContext: {
service: 'my-service',
version: 'version-1'
},
capture: { maxFramesFrames: 20, maxProperties: 100 }
});
```

## Using the Debugger

Expand Down