From a62b312d0bd6c257b34cbd1a5ae821a3be373f37 Mon Sep 17 00:00:00 2001
From: Russ Butler <russ.butler@arm.com>
Date: Thu, 23 Aug 2018 16:18:13 -0500
Subject: [PATCH] Add details to importer script docs

Add an example showing how to run the importer and a note to indicate
that it must be run from the mbed-os directory.
---
 tools/importer/README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/tools/importer/README.md b/tools/importer/README.md
index 1ef476ee21..e5d2ca1cce 100644
--- a/tools/importer/README.md
+++ b/tools/importer/README.md
@@ -48,3 +48,8 @@ Note: You must resolve any conflicts that arise during this cherry-pick process.
 ### Input to importer.py
 1. Repository: -r <repo_path> ( Example: CMSIS / Mbed-tls)
 2. `repo`_importer.json: -c <json_file>  (Example: cmsis_importer.json)
+
+For example the command below can be used to update CMSIS:
+`python tools\importer\importer.py -c tools\importer\cmsis_importer.json -r <path to cmsis repo>`
+
+Note: This script must be run from the mbed-os directory to work correctly.