Skip to content

Commit 495a32e

Browse files
committed
Merge pull request kaazing#18 from michaelcretzman/patch-2
Create README.md
2 parents 7ff924d + 7327051 commit 495a32e

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

amqp-0-9-1/README.md

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

0 commit comments

Comments
 (0)