summaryrefslogtreecommitdiffstats
path: root/plugin/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'plugin/doc.go')
-rw-r--r--plugin/doc.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugin/doc.go b/plugin/doc.go
new file mode 100644
index 000000000..b6806365b
--- /dev/null
+++ b/plugin/doc.go
@@ -0,0 +1,9 @@
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+
+// The plugin package is used by Mattermost server plugins written in go. It also enables the
+// Mattermost server to manage and interact with the running plugin environment.
+//
+// Note that this package exports a large number of types prefixed with Z_. These are public only
+// to allow their use with Hashicorp's go-plugin (and net/rpc). Do not use these directly.
+package plugin