From d17fe944ccbfb25ff535d04aaee616df6672044b Mon Sep 17 00:00:00 2001
From: Nathan Lasseter <nathan.je.lasseter@googlemail.com>
Date: Fri, 28 Jan 2011 19:46:31 +0000
Subject: Added TODO and textiled docs

---
 README.textile | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.textile

(limited to 'README.textile')

diff --git a/README.textile b/README.textile
new file mode 100644
index 0000000..42f05f3
--- /dev/null
+++ b/README.textile
@@ -0,0 +1,28 @@
+h1. erlbal
+
+erlbal is an erlang load balancer.
+
+h2. Balancer calls:
+
+* start_bal/0 spawns a balancer.
+* stop_bal/1 takes a balancer and kills all of its servers and then kills the balancer.
+* list_servers/1 takes a balancer and returns a list of the servers it balances over.
+
+h2. Server calls:
+
+* start_server/2 takes a balancer, a node and a function and spawns a server on the node to serve the function.
+* stop_server/2 takes a balancer and a server PID and stops the server and removes it from the balancer.
+
+h2. Request calls:
+
+* make_request/1 takes a balancer and returns the response from the server.
+* make_request/2 takes a balancer and an argument and returns the response from the server.
+
+h2. Info
+
+p. The balancer round robins requests between erlang processes.
+When it receives a request, it forwards it on to the next server in the round robin.
+The server then runs the function with the argument passed to it and returns a response to the balancer.
+The balancer forwards the response back to the requestor.
+
+p. The function arg could be anything, so you can pass multiple args in a tuple or list, etc.
-- 
cgit v1.2.3

