Permalink
Browse files

README

  • Loading branch information...
1 parent 2ca1e74 commit 9b28ba9466e2c32e09f28cc6ca542476574963ad @heynemann committed Jul 17, 2012
Showing with 28 additions and 0 deletions.
  1. +28 −0 README.md
View
@@ -23,4 +23,32 @@ Installing r³ is as easy as:
After successful installation, you'll have three new commands: `r3-app`,
`r3-map` and `r3-web`.
+Running
+-------
+
+In order to use r³ you must have a redis database running. Getting one up in
+your system is beyond the scope of this document.
+
+We'll assume you have one running at 127.0.0.1, port 7778 and configured to
+require the password 'r3' using database 0.
+
+The service that is at the heart of r³ is `r3-app`. It is the web-server that
+will receive requests for map-reduce jobs and return the results.
+
+To run `r3-app`, given the above redis back-end, type:
+
+ r3-app --redis-port=7778 --redis-pass=r3 -c config.py
+
+The `config.py` argument tells r³ which `input stream processors` and
+`reducers` should be enabled.
+
+We'll learn more about the configuration file below.
+
+Given that you have a proper configuration file, your r3 service will be
+available at `http://localhost:8888`.
+
+As to how we actually perform a map-reduce operation, we'll see that after the
+`mapper` section.
+
+

0 comments on commit 9b28ba9

Please sign in to comment.