From 1f2e93383b693c51d5a0db6ca9cf2015a6cd721e Mon Sep 17 00:00:00 2001
From: Hongjun Ni <hongjun.ni@intel.com>
Date: Thu, 8 Sep 2016 23:37:16 +0800
Subject: HONEYCOMB-46: Add NSH_SFC Readme doc

Change-Id: Id1f8f17d025ebba07db0d138f881384306046487
Signed-off-by: Hongjun Ni <hongjun.ni@intel.com>
(cherry picked from commit 2d6efba64a5050cb8349c874b5e4d7dadacb28e0)
---
 nsh/Readme.adoc | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 nsh/Readme.adoc

(limited to 'nsh/Readme.adoc')

diff --git a/nsh/Readme.adoc b/nsh/Readme.adoc
new file mode 100644
index 000000000..1ae29484a
--- /dev/null
+++ b/nsh/Readme.adoc
@@ -0,0 +1,14 @@
+= nsh
+
+This is a Honeycomb plugin providing mapping code between HC and NSH_SFC Plugin APIs.
+
+== Usage
+
+Refer to nsh_postman_collection.json for sample requests. All capabilities of NSH_SFC are demo-ed there.
+
+In order to make HC NSH plugin work, need to start vpp and load nsh_sfc plugin first.
+
+Please follow the right order to support NSH_SFC feature:
+(1). Creates vxlan-gpe interface.
+(2). Creates nsh-entry.
+(3). Creates nsh-map. 
\ No newline at end of file
-- 
cgit 1.2.3-korg

