[ignite-3] branch main updated: IGNITE-14438 Added README.md for cli and cli-common modules. Fixes #75

[sk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sk0x50 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git


The following commit(s) were added to refs/heads/main by this push:
     new 4d82a7e  IGNITE-14438 Added README.md for cli and cli-common modules. Fixes #75
4d82a7e is described below

commit 4d82a7ec1c462fff3ce7e33cd9c9014ffd372f98
Author: Kirill Gusakov <kg...@gmail.com>
AuthorDate: Thu Apr 1 11:29:58 2021 +0300

    IGNITE-14438 Added README.md for cli and cli-common modules. Fixes #75
    
    Signed-off-by: Slava Koptilin <sl...@gmail.com>
---
 modules/cli-common/README.md |  5 +++++
 modules/cli/README.md        | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)

diff --git a/modules/cli-common/README.md b/modules/cli-common/README.md
new file mode 100644
index 0000000..15496dc
--- /dev/null
+++ b/modules/cli-common/README.md
@@ -0,0 +1,5 @@
+# Ignite CLI common module
+
+This module contains all needed stuff for implementation external commands for Ignite CLI.
+For more details read the javadoc of `IgniteCommand` interface.
+
diff --git a/modules/cli/README.md b/modules/cli/README.md
new file mode 100644
index 0000000..934e6ff
--- /dev/null
+++ b/modules/cli/README.md
@@ -0,0 +1,32 @@
+# Ignite CLI module
+
+Ignite CLI tool is a single entry point for any management operations.
+
+## Build
+
+    mvn package -f ../../pom.xml
+## Run
+For Windows:
+
+    target/ignite.exe
+For Linux/MacOS:
+
+    ./target/ignite
+## Examples
+Download and prepare artifacts for run Ignite node:
+
+    ignite init
+Node start:
+
+    ignite start consistent-id
+Node stop:
+
+    ignite stop consistent-id
+Get current node configuration:
+
+    ignite config get --node-endpoint=localhost:10300
+Show help:
+
+    ignite --help
+    ignite init --help
+    ...