Browse Source

chore: update README files

JianBo He 2 years ago
parent
commit
13f50b2ba9
2 changed files with 28 additions and 0 deletions
  1. 16 0
      apps/emqx_conf/README.md
  2. 12 0
      apps/emqx_plugins/README.md

+ 16 - 0
apps/emqx_conf/README.md

@@ -0,0 +1,16 @@
+# Configuration Management
+
+This application provides configuration management capabilities for EMQX.
+
+This includes, during compilation:
+- Read all configuration schemas and generate the following files:
+  * `config-en.md`: documentation for all configuration options.
+  * `schema-en.json`: JSON description of all configuration schema options.
+  * `emqx.conf.example`: an example of a complete configuration file.
+
+At runtime, it provides:
+- Cluster configuration synchronization capability.
+  Responsible for synchronizing hot-update configurations from the HTTP API to the entire cluster
+  and ensuring consistency.
+
+In addition, this application manages system-level configurations such as `cluster`, `node`, `log`.

+ 12 - 0
apps/emqx_plugins/README.md

@@ -0,0 +1,12 @@
+# Plugins Management
+
+This application provides the feature for users to upload and install custom, Erlang-based plugins.
+
+More introduction about [Plugins](https://www.emqx.io/docs/en/v5.0/extensions/plugins.html#develop-emqx-plugins)
+
+See HTTP API to learn how to [Install/Uninstall a Plugin](https://www.emqx.io/docs/en/v5.0/admin/api-docs.html#tag/Plugins)
+
+## Plugin Template
+
+We provide a [plugin template](https://github.com/emqx/emqx-plugin-template) that
+you can use to learn how to write and package custom plugins.