Skip to content

Commit e8d4102

Browse files
mdumandagasimarslan
authored andcommitted
update README and documentation (#101)
1 parent 010f45a commit e8d4102

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

docs/getting_started.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,13 @@ An even simpler way is to install the client from the official Python Package In
1616
pip install hazelcast-python-client
1717

1818

19-
2019
Starting Hazelcast
2120
------------------
2221

23-
Before diving right into the configuration, you should have a running Hazelcast server. If you are already familiar
24-
with Hazelcast and have a server running, you can simply skip to the Configuration section.
22+
Before diving right into the configuration, you should have a running Hazelcast member. If you are already familiar
23+
with Hazelcast and have a member running, you can simply skip to the Configuration section.
2524

26-
If not, follow these steps to start an Hazelcast server in your local computer:
25+
If not, follow these steps to start an Hazelcast member in your local computer:
2726

2827
* Make sure that you have `Java <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ installed on your system.
2928
* Download the latest `Hazelcast release <https://hazelcast.org/download/>`_.
@@ -32,7 +31,9 @@ If not, follow these steps to start an Hazelcast server in your local computer:
3231
* If you are using Linux/MacOS, you can start a Hazelcast member with **start.sh** and stop the member you have started with **stop.sh** when you are done.
3332
* If you are using Windows, you can start a Hazelcast member with **start.bat** and stop the member you have started with **stop.bat** when you are done.
3433
* Refer to the `Using the Scripts In The Package <http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#using-the-scripts-in-the-package>`_ for more information about these scripts.
35-
* After successfully running these scripts, you should see the ip address and port of your member on your console. Take a note of these and jump right into the Configuration section!
34+
* If you use **start.sh/bat** again while your first Hazelcast member is running, you will start a second Hazelcast member. These members will join together to form a Hazelcast cluster.
35+
* You can increase the size of your cluster by repeating the step above as many times as you want.
36+
* After successfully running these scripts, you should see the ip address and port of your members on your console. Take a note of these and jump right into the Configuration section!
3637

3738

3839
Configuration

examples/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ This folder contains a collection of code samples which you can use to learn how
66
How to try these examples
77
-------------------------
88

9-
* To try these examples, you should have a running Hazelcast server. If you are already familiar with Hazelcast and have a server running, add its address and port to your configuration as shown in the [**/learning-basics/1-configure_client.py**](learning-basics/1-configure_client.py).
10-
* If not, follow these steps to start an Hazelcast server in your local computer:
9+
* To try these examples, you should have a running Hazelcast member. If you are already familiar with Hazelcast and have a member running, add its address and port to your configuration as shown in the [**/learning-basics/1-configure_client.py**](learning-basics/1-configure_client.py).
10+
* If not, follow these steps to start an Hazelcast member in your local computer:
1111
* Make sure that you have [Java](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed on your system.
1212
* Download the latest [Hazelcast release](https://hazelcast.org/download/).
1313
* Extract the zip file you have downloaded.
1414
* You should see a directory called **bin** which includes a few scripts and xml files.
1515
* If you are using Linux/MacOS, you can start a Hazelcast member with **start.sh** and stop the member you have started with **stop.sh** when you are done.
1616
* If you are using Windows, you can start a Hazelcast member with **start.bat** and stop the member you have started with **stop.bat** when you are done.
1717
* Refer to the [Using the Scripts In The Package](http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#using-the-scripts-in-the-package) for more information about these scripts.
18-
* After successfully running these scripts, you should see the ip address and port of your member on your console. Take a note of these.
19-
* Add this address and port to your configuration as shown in the [**/learning-basics/1-configure_client.py**](learning-basics/1-configure_client.py).
18+
* If you use **start.sh/bat** again while your first Hazelcast member is running, you will start a second Hazelcast member. These members will join together to form a Hazelcast cluster.
19+
* You can increase the size of your cluster by repeating the step above as many times as you want.
20+
* After successfully running these scripts, you should see the ip address and port of your members on your console. Take a note of these.
21+
* Add these addresses and ports to your configuration as shown in the [**/learning-basics/1-configure_client.py**](learning-basics/1-configure_client.py).
2022
* After configuring your client as described above, you are ready to learn using Hazelcast Python Client with these examples.
2123

2224
Included example folders

examples/learning-basics/1-configure_client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@
1010
config = hazelcast.ClientConfig()
1111
print("Cluster name: {}".format(config.group_config.name))
1212

13-
# Add server's host:port to the configuration
13+
# Add member's host:port to the configuration.
14+
# For each member on your Hazelcast cluster, you should add its host:port pair to the configuration.
1415
config.network_config.addresses.append("127.0.0.1:5701")
16+
config.network_config.addresses.append("127.0.0.1:5702")
1517

1618
# Create a client using the configuration above
1719
client = hazelcast.HazelcastClient(config)

0 commit comments

Comments
 (0)