Skip to content

Commit 62899bf

Browse files
author
Michael Cretzman
committed
Create README.md
1 parent 6736190 commit 62899bf

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

ws/README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# java.client
2+
3+
# About This Project
4+
5+
This project contains the community version of the Java [WebSocket] (https://tools.ietf.org/html/rfc6455) Client Library.
6+
7+
The java.client project implements the [WebSocket standard](https://tools.ietf.org/html/rfc6455) in Java. It provides a WebSocket client API that enables developers to build Java applications that communicate over WebSocket with an RFC-6455 endpoint, such KAAZING Gateway.
8+
9+
Developers can include the Java WebSocket Client using the following maven dependency to develop and run web applications:
10+
11+
```xml
12+
<dependency>
13+
<groupId>org.kaazing</groupId>
14+
<artifactId>gateway.client.java</artifactId>
15+
<version>[5.1.0.0,5.2.0.0)</version>
16+
</dependency>
17+
18+
```
19+
20+
# Building This Project
21+
22+
## Minimum Requirements for Building the Projects in This Repo
23+
24+
* Java SE Development Kit (JDK) 7 or higher
25+
* maven 3.0.5 or higher
26+
27+
## Steps for Building this Project
28+
29+
0. Clone the repo: ```git clone https://github.com/kaazing/java.client.git```
30+
0. Go to the cloned directory: ```cd java.client```
31+
0. Build the project: ```mvn clean install```
32+
33+
# Running the WebSocket demo
34+
35+
## From the command-line
36+
0. Change directory: ```cd ws/demo/target```
37+
0. Run the demo application: ```java -cp . -jar gateway.client.java.demo-develop-SNAPSHOT.jar```
38+
39+
## From within Eclipse
40+
0. Import the project in Eclipse
41+
0. Under `gateway.client.java.demo` project, right-click on `WebSocketFrame.java` or `WebSocketApplet.java` in
42+
src/main/java/org.kaazing.net.ws.demo and run!
43+
44+
# Using KAAZING Gateway or any RFC-6455 Endpoint
45+
46+
You can use an RFC-6455 endpoint, such KAAZING Gateway, to connect to a back-end service. To learn how to administer the Gateway, its configuration files, and security, see the documentation on [developer.kaazing.com](http://developer.kaazing.com/documentation/5.0/index.html).
47+
48+
# Learning How to Develop Client Applications
49+
50+
To learn how to develop client applications with these projects, see the documentation on [developer.kaazing.com](http://developer.kaazing.com/documentation/5.0/index.html).
51+
52+
# View a Running Demo
53+
54+
To view demos of clients built with these projects, see [kaazing.org](http://kaazing.org/)

0 commit comments

Comments
 (0)