From 2f0582224f8a20737bf18e1e1913140614baa0ff Mon Sep 17 00:00:00 2001
From: James Sumners <jsumners@newrelic.com>
Date: Thu, 29 Feb 2024 09:04:19 -0500
Subject: [PATCH] update readme

---
 README.md | 51 ++++++++++++---------------------------------------
 1 file changed, 12 insertions(+), 39 deletions(-)

diff --git a/README.md b/README.md
index ef566c0..6a33434 100644
--- a/README.md
+++ b/README.md
@@ -22,9 +22,15 @@ $ npm install --save @newrelic/native-metrics
 ```
 
 Note that this is a native module and thus must be compiled to function.
-Pre-built binaries are provided for Linux servers running supported versions of
-Node. If you are not using Linux or not using a supported version of Node, you
-will need to have a compiler installed on the machine where this is to be
+Pre-built binaries are included in the package for the following platforms, across all LTS versions of Node.js:
+
++ Linux/amd64
++ Linux/arm64
++ macOS/arm64
++ Windows/x64
++ Windows/x86
+
+If your system does not match the above matrix, you will need to have a compiler installed on the machine where this is to be
 deployed. See [node-gyp](https://www.npmjs.com/package/node-gyp#installation)
 for more information on compiling native addons.
 
@@ -33,43 +39,10 @@ another, the two machines must have the same operating system and architecture.
 If they are not, you will need to re-build the native module after deploying in
 order to get the correct binaries.
 
-During installation, the module will first attempt build from source on the
-target machine. If that fails, it will attempt to download a pre-built binary
-for your system. You can disable the download attempt by setting
-`NR_NATIVE_METRICS_NO_DOWNLOAD` to `true` in your environment before
-installation.
-
-```sh
-$ export NR_NATIVE_METRICS_NO_DOWNLOAD=true
-$ npm install @newrelic/native-metrics
-```
-
-If you would like to skip the build step and only attempt to download a
-pre-build binary, set `NR_NATIVE_METRICS_NO_BUILD` to `true`.
-
-```sh
-$ export NR_NATIVE_METRICS_NO_BUILD=true
-$ npm install @newrelic/native-metrics
-```
-
-If both env vars are set, `NO_BUILD` will override `NO_DOWNLOAD`.
-
-If you are working behind a firewall and want to cache the downloads internally
-you can set the value of the download host and remote path instead of forcing a
-build:
-
-```sh
-$ export NR_NATIVE_METRICS_DOWNLOAD_HOST=http://your-internal-cache/
-$ export NR_NATIVE_METRICS_REMOTE_PATH=path/to/download/folder/
-$ npm install @newrelic/native-metrics
-```
-
-You can also specify a proxy host to route requests through using the `NR_NATIVE_METRICS_PROXY_HOST` environment variable:
+During installation, the module will first attempt to locate a prebuilt binary for the target machine within its included list of prebuilt binaries. If that fails, it will attempt a standard [node-gyp](https://www.npmjs.com/package/node-gyp#installation) build. If you do not want to use prebuilt binary, or know that it will need to be built, you can force a build:
 
 ```sh
-$ export NR_NATIVE_METRICS_NO_BUILD=true
-$ export NR_NATIVE_METRICS_PROXY_HOST=http://your-proxy-host/
-$ npm install @newrelic/native-metrics
+$ npm install @newrelic/native-metrics --build-from-source
 ```
 
 For more information, please see the agent [installation guide][install-node] and [compatibility and requirements][compatibility].
@@ -184,4 +157,4 @@ The Native Metrics for New Relic Node.js Agent package is licensed under the [Ap
 [1]: https://img.shields.io/npm/v/@newrelic/native-metrics.svg
 [2]: https://www.npmjs.com/package/@newrelic/native-metrics
 [3]: https://codecov.io/gh/newrelic/node-native-metrics/branch/main/graph/badge.svg
-[4]: https://codecov.io/gh/newrelic/node-native-metrics
\ No newline at end of file
+[4]: https://codecov.io/gh/newrelic/node-native-metrics