summaryrefslogtreecommitdiff
path: root/common/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'common/doc.go')
-rw-r--r--common/doc.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/common/doc.go b/common/doc.go
new file mode 100644
index 00000000..adc03351
--- /dev/null
+++ b/common/doc.go
@@ -0,0 +1,9 @@
+/*
+Package common used to collect common interfaces/structures which might be implemented (or imported) by a different plugins.
+For example, 'pubsub' interface might be implemented by memory, redis, websockets and many other plugins.
+
+Folders:
+- kv - contains KV interfaces and structures
+- pubsub - contains pub-sub interfaces and structures
+*/
+package common