HONEYCOMB-46: Add NSH_SFC Readme doc
authorHongjun Ni <hongjun.ni@intel.com>
Thu, 8 Sep 2016 15:37:16 +0000 (23:37 +0800)
committerMaros Marsalek <mmarsale@cisco.com>
Wed, 14 Sep 2016 07:45:04 +0000 (07:45 +0000)
Change-Id: Id1f8f17d025ebba07db0d138f881384306046487
Signed-off-by: Hongjun Ni <hongjun.ni@intel.com>
(cherry picked from commit 2d6efba64a5050cb8349c874b5e4d7dadacb28e0)

nsh/Readme.adoc [new file with mode: 0644]

diff --git a/nsh/Readme.adoc b/nsh/Readme.adoc
new file mode 100644 (file)
index 0000000..1ae2948
--- /dev/null
@@ -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