Skip to content

Commit 87295c3

Browse files
committed
Adding README
1 parent a8026d6 commit 87295c3

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

Diff for: README.md

+46-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,48 @@
11
# Chat Server with Cloud Haskell
22

3-
An implementation of a Chat Server with [Cloud Haskell](http://haskell-distributed.github.io/)
3+
An implementation of a Chat Server with [Cloud Haskell](http://haskell-distributed.github.io/)
4+
5+
6+
# Installation
7+
8+
Clone this repository and run `stack install` in its root folder.
9+
10+
11+
# Run server
12+
13+
To run the server, you must provide the following arguments:
14+
15+
- `host`: Address of the host machine for the chat server.
16+
- `port`: Port where the server is to be served.
17+
- `room`: Name for this chat room.
18+
19+
For example:
20+
21+
```
22+
chatServer --host 192.168.0.33 --port 8080 --room myChat
23+
```
24+
25+
As soon as the server is launched it will prompt its `EndPointAddress`, which is needed for clients to establish a connection.
26+
The prompt log will look like the following:
27+
28+
```
29+
Server launched at: 192.168.0.33:8080:0
30+
```
31+
32+
# Run client
33+
34+
To run the client, you must provide the following arguments:
35+
36+
- `address`: [EndPointAddress](http://haskell-distributed.github.io/tutorials/tutorial-NT2.html) of the remote (or local) machine serving the chat room.
37+
- `host`: Address of the host machine for the chat client.
38+
- `port`: Port where the client is to be served.
39+
- `room`: Name of the chat room this client will connect to.
40+
41+
42+
For example:
43+
44+
```
45+
chatClient --address 192.168.0.33:8080:0 --host 127.0.0.1 --port 8880 --room myChat
46+
```
47+
48+
Note that the `EndPointAddress` you must provide is the value provided by the chat server once it has been launched.

0 commit comments

Comments
 (0)