Add documentation

creationix · creationix · commit 41e3d7fc82dc · 2009-07-29T00:10:10.000-05:00
diff --git a/README.markdown b/README.markdown
@@ -0,0 +1,19 @@
+# PostgreSQL for Javascript
+
+This library is a implementation of the PostgreSQL backend/frontend protocol in javascript.
+It uses the node.js tcp and event libraries.  A javascript md5 library is included for servers that require md5 password hashing.
+
+## Example use
+
+    include('md5.js');
+    var postgres = require('postgres.js');
+
+    function onLoad() {
+      var db = new postgres.Connection("database", "username", "password");
+      db.query("SELECT * FROM sometable", function (data) {
+        p(data);    
+      });
+      db.close();
+    }
+
+
diff --git a/postgres.js b/postgres.js
@@ -1,8 +1,6 @@
-
 var DEBUG = 0;
 
 include('util.js');
-include('md5.js');
 
 function add_int(message, num) {
 	var part;
@@ -379,15 +377,4 @@ exports.Connection = function (database, username, password) {
   }
 };
 
-function onLoad() {
-
-  var db = new exports.Connection("databasename", "username", "password");
-  db.query("SELECT id FROM users LIMIT 1", p);
-  db.query("SELECT id FROM users where id > 2 LIMIT 1", p);
-  db.query("SELECT id FROM users WHERE id > 5 LIMIT 1", p);
-  setTimeout(function () {
-    db.query("SELECT * FROM users", p);
-    db.close();
-  }, 20);
-}
 
diff --git a/sample.js b/sample.js
@@ -0,0 +1,12 @@
+include('md5.js');
+var postgres = require('postgres.js');
+
+function onLoad() {
+  var db = new postgres.Connection("database", "username", "password");
+  db.query("SELECT * FROM sometable", function (data) {
+    p(data);    
+  });
+  db.close();
+}
+
+
