From 1c5f73f5413ff71450640699cbe0f3ba5f38b909 Mon Sep 17 00:00:00 2001
From: Matt Ranney <mjr@ranney.com>
Date: Wed, 20 Oct 2010 16:38:33 -0700
Subject: [PATCH] Organize examples.

---
 examples/{example_auth.js => auth.js}             | 4 +++-
 examples/{example_file.js => file.js}             | 2 ++
 examples/{example_multi.js => multi.js}           | 0
 examples/{example_multi2.js => multi2.js}         | 0
 examples/{example_psubscribe.js => psubscribe.js} | 0
 examples/{example_pub_sub.js => pub_sub.js}       | 1 +
 examples/{example.js => simple.js}                | 0
 7 files changed, 6 insertions(+), 1 deletion(-)
 rename examples/{example_auth.js => auth.js} (60%)
 rename examples/{example_file.js => file.js} (93%)
 rename examples/{example_multi.js => multi.js} (100%)
 rename examples/{example_multi2.js => multi2.js} (100%)
 rename examples/{example_psubscribe.js => psubscribe.js} (100%)
 rename examples/{example_pub_sub.js => pub_sub.js} (89%)
 rename examples/{example.js => simple.js} (100%)

diff --git a/examples/example_auth.js b/examples/auth.js
similarity index 60%
rename from examples/example_auth.js
rename to examples/auth.js
index 7f53d3b27f..06b90583db 100644
--- a/examples/example_auth.js
+++ b/examples/auth.js
@@ -1,7 +1,9 @@
+// Note - Eventually this functionality will be built in to the client library
+
 var redis  = require("redis"),
     client = redis.createClient();
 
-// whenever the client connects, make sure 
+// whenever the client connects, make sure to auth
 client.on("connect", function () {
     client.auth("somepass", redis.print);
 });
diff --git a/examples/example_file.js b/examples/file.js
similarity index 93%
rename from examples/example_file.js
rename to examples/file.js
index f048615845..4d2b5d1c98 100644
--- a/examples/example_file.js
+++ b/examples/file.js
@@ -1,3 +1,5 @@
+// Read a file from disk, store it in Redis, then read it back from Redis.
+
 var redis = require("redis"),
     client = redis.createClient(),
     fs = require("fs"),
diff --git a/examples/example_multi.js b/examples/multi.js
similarity index 100%
rename from examples/example_multi.js
rename to examples/multi.js
diff --git a/examples/example_multi2.js b/examples/multi2.js
similarity index 100%
rename from examples/example_multi2.js
rename to examples/multi2.js
diff --git a/examples/example_psubscribe.js b/examples/psubscribe.js
similarity index 100%
rename from examples/example_psubscribe.js
rename to examples/psubscribe.js
diff --git a/examples/example_pub_sub.js b/examples/pub_sub.js
similarity index 89%
rename from examples/example_pub_sub.js
rename to examples/pub_sub.js
index 0d3ce86f9d..d64cc428d8 100644
--- a/examples/example_pub_sub.js
+++ b/examples/pub_sub.js
@@ -4,6 +4,7 @@ var redis = require("redis"),
 
 redis.debug_mode = false;
 
+// Most clients probably don't do much on "subscribe".  This example uses it to coordinate things within one program.
 client1.on("subscribe", function (channel, count) {
     console.log("client1 subscribed to " + channel + ", " + count + " total subscriptions");
     if (count === 2) {
diff --git a/examples/example.js b/examples/simple.js
similarity index 100%
rename from examples/example.js
rename to examples/simple.js