Skip to content

Commit

Permalink
Merge pull request newrelic#154 from bizob2828/update-readme
Browse files Browse the repository at this point in the history
docs: updated readme to specify this no longer is a standalone package
  • Loading branch information
bizob2828 committed Jun 28, 2023
2 parents 990f484 + 8a83a82 commit 9cbac28
Showing 1 changed file with 1 addition and 12 deletions.
13 changes: 1 addition & 12 deletions lib/instrumentation/koa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,7 @@ This module is a dependency of the agent and is installed by default when you in

## Installation

Typically, most users use the version auto-installed by the agent. You can see agent install instructions [here](https://github.com/newrelic/node-newrelic#installation-and-getting-started).

In some cases, installing a specific version is ideal. For example, new features or major changes might be released via a major version update to this module, prior to inclusion in the main New Relic Node.js Agent.

```
npm install @newrelic/koa
```

```js
// index.js
require('@newrelic/koa')
```
This package is [a dependency of the the Node Agent](https://github.com/newrelic/node-newrelic/blob/main/package.json#L189), and the average user should not need to install it manually.

For more information, please see the agent [installation guide][3].

Expand Down

0 comments on commit 9cbac28

Please sign in to comment.