summaryrefslogtreecommitdiffstats
path: root/tools/archetype/Readme.adoc
diff options
context:
space:
mode:
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
+