From c961bd752be1fb2eee707cb5c7c44d1bda0894d2 Mon Sep 17 00:00:00 2001
From: Jan Srnicek <jsrnicek@cisco.com>
Date: Thu, 25 Aug 2016 16:27:23 +0200
Subject: HONEYCOMB-140 - Honeycomb Plugin Archetype

Change-Id: I6e04fb769e82fb539dbd6a79bb465974796137a4
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
---
 tools/archetype/Readme.adoc | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 tools/archetype/Readme.adoc

(limited to 'tools/archetype/Readme.adoc')

diff --git a/tools/archetype/Readme.adoc b/tools/archetype/Readme.adoc
new file mode 100644
index 000000000..24040b89a
--- /dev/null
+++ b/tools/archetype/Readme.adoc
@@ -0,0 +1,13 @@
+Honeycomb Plugin Archetype
+
+    This is archetype for creating plugins for Honeycomb platform
+
+How to use it :
+
+    archetype:generate -DarchetypeGroupId=io.fd.honeycomb.tools -DarchetypeArtifactId=honeycomb-plugin-archetype -DarchetypeVersion=1.0.0-SNAPSHOT
+
+This will generate main aggregator project containing two sub-projects
+
+    -api  - project that should contain yang model files for restconf/netconf DTO classes
+    -impl - implementation project that should contain plugin translation code + wiring
+
-- 
cgit 1.2.3-korg

