Skip to content

Commit 9c29f98

Browse files
author
Michael Cretzman
authored
Update README.md
1 parent 79de6a1 commit 9c29f98

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

android/ws/README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,40 @@
11
# Kaazing Android WebSocket Echo Tutorial
22

3-
This tutorial shows how Android application can communicate over the web with an `echo` service running within Kaazing WebSocket Gateway using Kaazing Java WebSocket Client library. The application sends text messages to the `echo` service over WebSocket.
4-
The `echo` service, running inside the Kaazing WebSocket Gateway, reflects back the message that is received by the Android application.
3+
This Android app communicates with a remote `Echo` service hosted by Kaazing WebSocket Gateway. The app sends and receives text messages with the `Echo` service over WebSocket.
54

6-
## Minimum Requirements for Running or Building Kaazing Android Echo WebSocket tutorial
5+
## Minimum Requirements for Running or Building
76

87
* Java 1.8
98
* Gradle 2.10 or higher
109
* Android Studio 2.10 or higher
1110
* Android SDK 4.4 or higher
1211

13-
## Steps for building and running the project
12+
## Steps for Building and Running the Project
1413

1514
- Build the application using Android Studio
1615
- Open the project in Android Studio by navigating to the project directory
1716
- Build the project by selecting Build/Rebuild Project
1817
- Run the application in Android Simulator
19-
- Create Android Virtual Device (AVD) for API level 19 (KitKat) or higher. For more information refer to [Create and Manage Virtual Devices](https://developer.android.com/studio/run/managing-avds.html)
18+
- Create an Android Virtual Device (AVD) for API level 19 (KitKat) or higher. For more information refer to [Create and Manage Virtual Devices](https://developer.android.com/studio/run/managing-avds.html)
2019
- Run the application from Android Studio by selecting Run/Run Project. Refer to [Running Your App](https://developer.android.com/training/basics/firstapp/running-app.html) for more information.
20+
21+
After installing Android Studio, update the following files with the Android SDK path or version (if necessary):
22+
- local.properties
23+
- project.properties
24+
- AndroidManifest.xml
25+
- app/build.gradle
26+
27+
In you experience the error `Could not find or load main class org.gradle.wrapper.GradleWrapperMain`, add a wrapper in the build.gradle file:
28+
29+
```
30+
task wrapper(type: Wrapper) {
31+
gradleVersion = <gradle-version-installed>
32+
}
33+
```
2134

2235
## Interact with Kaazing Android WebSocket Client API
2336

24-
Checklist how to create Kaazing Android WebSocket Echo application from scratch, to be able to send and receive Echo messages over WebSocket can be found [here](http://kaazing.com/doc/5.0/websocket_client_docs/dev-android/o_dev_android.html).
37+
Documentation that explains how to create Kaazing Android WebSocket apps from scratch can be found [here](http://kaazing.com/doc/5.0/websocket_client_docs/dev-android/o_dev_android.html).
2538

2639
## API Documentation
2740

0 commit comments

Comments
 (0)