summaryrefslogtreecommitdiffstats
path: root/tools/archetype/Readme.adoc
diff options
context:
space:
mode:
authorJan Srnicek <jsrnicek@cisco.com>2016-08-25 16:27:23 +0200
committerMaros Marsalek <mmarsale@cisco.com>2016-08-30 15:43:49 +0000
commitc961bd752be1fb2eee707cb5c7c44d1bda0894d2 (patch)
tree780c4f0c9e796f3a8aa4f9116ee83f396de74ccc /tools/archetype/Readme.adoc
parent23f210d1477a4dd43d939714a2f3c78fa30d466c (diff)
HONEYCOMB-140 - Honeycomb Plugin Archetype
Change-Id: I6e04fb769e82fb539dbd6a79bb465974796137a4 Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
Diffstat (limited to 'tools/archetype/Readme.adoc')
-rw-r--r--tools/archetype/Readme.adoc13
1 files changed, 13 insertions, 0 deletions
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
+