From 8e9970d5a732e7536b6f25e246792837e6cdfb33 Mon Sep 17 00:00:00 2001
From: Andrew Finlay <andrewf@blackmagicdesign.com>
Date: Thu, 21 Mar 2019 16:11:19 +1100
Subject: [PATCH] [skip ci] Rough draft for `nyc instrument` docs

Adds basic usage and key limitations
---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 90d351eef..c746ecd70 100644
--- a/README.md
+++ b/README.md
@@ -195,6 +195,18 @@ Install custom reporters as a development dependency and you can use the `--repo
 nyc report --reporter=<custom-reporter-name>
 ```
 
+## Producing instrumented source
+
+nyc can produce a set of instrumented source files, suitable for client side deployment, by running:
+
+```bash
+nyc instrument <input> [output]
+```
+
+Where `input` can be any file or directory within the project root directory.
+The `output` directory is optional and can be located anywhere, if it is not set the instrumented code with be sent to `stdout`.
+
+
 ## Setting the project root directory
 
 nyc runs a lot of file system operations relative to the project root directory.