[ignite-3] branch ignite-3.0.0-alpha5 updated: IGNITE-17126: Update README.md with Alpha 5 features (#867)

[am...@apache.org]

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

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


The following commit(s) were added to refs/heads/ignite-3.0.0-alpha5 by this push:
     new 7fa7b61f9 IGNITE-17126: Update README.md with Alpha 5 features (#867)
7fa7b61f9 is described below

commit 7fa7b61f991dd48a0f59dde506ba602f656f9942
Author: Alexandr <ap...@gmail.com>
AuthorDate: Wed Jun 8 19:16:25 2022 +0300

    IGNITE-17126: Update README.md with Alpha 5 features (#867)
---
 assembly/README.md | 28 +++++++++++++++++++++-------
 examples/README.md |  1 +
 2 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/assembly/README.md b/assembly/README.md
index 489382c87..d8ced5c6a 100644
--- a/assembly/README.md
+++ b/assembly/README.md
@@ -1,4 +1,4 @@
-# Apache Ignite 3 Alpha 3
+# Apache Ignite 3 Alpha 5
 
 Apache Ignite is a distributed database for high-performance computing with in-memory speed.
 
@@ -16,21 +16,21 @@ The current alpha version includes the following features:
 
 ## Installation
 
-1. Download Ignite 3 Alpha 3:
+1. Download Ignite 3 Alpha 5:
    ```
-   curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha3/apache-ignite-3.0.0-alpha3.zip" -o apache-ignite-3.0.0-alpha3.zip
+   curl -L "https://www.apache.org/dyn/mirrors/mirrors.cgi?action=download&filename=ignite/3.0.0-alpha5/apache-ignite-3.0.0-alpha5.zip" -o apache-ignite-3.0.0-alpha5.zip
    ```
 2. Unzip the downloaded file:
    ```
-   unzip apache-ignite-3.0.0-alpha3.zip && cd apache-ignite-3.0.0-alpha3
+   unzip apache-ignite-3.0.0-alpha5.zip && cd apache-ignite-3.0.0-alpha5
    ```
 3. Add your installation directory to the PATH environment variable:
    ```
    echo 'export IGNITE_HOME="'`pwd`'"' >> ~/.bash_profile && echo 'export PATH="$IGNITE_HOME:$PATH"' >> ~/.bash_profile && source ~/.bash_profile
    ```
-4. (optional) If you will start the cluster locally, install the core artifacts:
+4. (optional) If you start the cluster locally then install the core artifacts:
    ```
-   ignite init
+   ignite bootstrap
    ```
 
 ## Running Examples
@@ -42,6 +42,9 @@ The following examples are included:
 * `RecordViewExample` - demonstrates the usage of the `org.apache.ignite.table.RecordView` API
 * `KeyValueViewExample` - demonstrates the usage of the `org.apache.ignite.table.KeyValueView` API
 * `SqlJdbcExample` - demonstrates the usage of the Apache Ignite JDBC driver.
+* `SqlApiExample` - demonstrates the usage of the Java API for SQL.
+* `VolatilePageMemoryStorageExample` - demonstrates the usage of the PageMemory storage engine configured with an in-memory data region.
+* `PersistentPageMemoryStorageExample` - demonstrates the usage of the PageMemory storage engine configured with a persistent data region.
 
 To run any other example, do the following:
 1. Import the examples project into you IDE.
@@ -49,4 +52,15 @@ To run any other example, do the following:
    ```
    ignite node start --config=$IGNITE_HOME/examples/config/ignite-config.json my-first-node
    ```
-3. Run the preferred example in the IDE.
+3. (optional) If the cluster is not initialized then initialize the cluster:
+   ```
+   ignite cluster init --cluster-name=ignite-cluster --node-endpoint=localhost:10300 --meta-storage-node=my-first-node
+   ```
+4. Run the preferred example in the IDE.
+
+## Using CLI
+
+Alpha 5 leverages the advantage of using the CLI for the development. Updated CLI ships the following features:
+* Bash auto-completions. If you are using bash/zsh you can hit the TAB during typing ignite commands.
+* Interactive mode. Enter the interactive by running `ignite` without arguments.
+* SQL REPL. Run SQL queries right from your terminal with `ignite sql` command.
diff --git a/examples/README.md b/examples/README.md
index 410cbf94e..1a85dbcc6 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -9,6 +9,7 @@ The following examples are included:
 * `RecordViewExample` - demonstrates the usage of the `org.apache.ignite.table.RecordView` API
 * `KeyValueViewExample` - demonstrates the usage of the `org.apache.ignite.table.KeyValueView` API
 * `SqlJdbcExample` - demonstrates the usage of the Apache Ignite JDBC driver.
+* `SqlApiExample` - demonstrates the usage of the Java API for SQL.
 * `VolatilePageMemoryStorageExample` - demonstrates the usage of the PageMemory storage engine configured with an in-memory data region.
 * `PersistentPageMemoryStorageExample` - demonstrates the usage of the PageMemory storage engine configured with a persistent data region.