path: root/infra/translate-api/asciidoc/Readme.adoc
diff options
Diffstat (limited to 'infra/translate-api/asciidoc/Readme.adoc')
1 files changed, 9 insertions, 0 deletions
diff --git a/infra/translate-api/asciidoc/Readme.adoc b/infra/translate-api/asciidoc/Readme.adoc
new file mode 100644
index 0000000..9e20874
--- /dev/null
+++ b/infra/translate-api/asciidoc/Readme.adoc
@@ -0,0 +1,9 @@
+= Honeycomb translation layer API
+Extensible API for translation between Binding Aware data and actual device data.
+Consists of readers and writers responsible for communication with the device.
+Provides registry of readers and writers for the data layer.
+For every supported YANG model there should be at least one reader and writer registered.
+Readers and writers form two tree structures matching corresponding YANG models.
+Readers and writers can be attached to any non-leaf YANG node. \ No newline at end of file