Skip to content

Commit

Permalink
[docs] remove weird distinctions/disclaimer in the API reference (#256)
Browse files Browse the repository at this point in the history
This prose makes it sound like the doc is only for advanced users or for adding auto-instrumentation, and it's somehow different than "using" the beeline.  Let's clear that up - it's a reference for the API and not meant to be the place you go for usage examples.
  • Loading branch information
Chris Toshok authored Oct 7, 2020
1 parent 2530a8f commit 7f5718e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
**This document is intended for anyone looking to write custom instrumentation for your favorite NPM package.**
This document is intended as a reference to the Beeline for Node.js API.

If you're looking to understand how to **use** the Beeline for Node.js in your application,
If you're looking for examples of how to use the Beeline in your application,
please check out our [Usage and Examples](https://docs.honeycomb.io/beeline/nodejs/) documentation instead.

## Accessing the API
Expand Down

0 comments on commit 7f5718e

Please sign in to comment.