Documentation and examples

Author: alaisi

README.md

@@ -2,6 +2,8 @@
 
 Pg-async-driver is a non-blocking Java driver for PostgreSQL. The driver supports connection pooling, prepared statements, transactions and all standard SQL types. 
 
+## Download
+
 Pg-async-driver is available on [Maven Central](http://search.maven.org/#search|ga|1|g%3A%22com.github.alaisi.pgasync%22).
 
 ```xml
@@ -42,9 +44,28 @@ pool.query("SELECT 'Hello world!' AS message",
 
 ### Connection pools
 
+Connection pools are created with [`com.github.pgasync.ConnectionPoolBuilder`](https://github.com/alaisi/pg-async-driver/blob/master/src/main/java/com/github/pgasync/ConnectionPoolBuilder.java)
+
+```java
+ConnectionPool pool = return new ConnectionPoolBuilder()
+    .database("db")
+    .username("user")
+    .password("pass")
+    .poolSize(20)
+    .build();
+```
+
+Each connection pool will start one IO thread used in communicating with PostgreSQL backend.
+
+### Prepared statements
+
+TODO
+
+### Transactions
+
 TODO
 
 ## References
 * [Scala postgresql-async](https://raw.github.com/mauricio/postgresql-async)
-* [PostgreSQL JDBC Driver](http://jdbc.postgresql.org)
+* [PostgreSQL JDBC Driver](http://jdbc.postgresql.org/about/about.html)
 

src/main/java/com/github/pgasync/ConnectionPoolBuilder.java

@@ -1,13 +1,36 @@
+/*
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.github.pgasync;
 
 import com.github.pgasync.impl.netty.NettyPgConnectionPool;
 
 /**
- * Builder
+ * Builder for creating {@link ConnectionPool} instances.
+ * 
+ * @author Antti Laisi
  */
 public class ConnectionPoolBuilder {
 
-    PoolProperties properties = new PoolProperties();
+    final PoolProperties properties = new PoolProperties();
+
+    /**
+     * @return Pool ready for use
+     */
+    public ConnectionPool build() {
+        return new NettyPgConnectionPool(properties);
+    }
 
     public ConnectionPoolBuilder hostname(String hostname) {
         properties.setHostname(hostname);
@@ -39,10 +62,9 @@ public ConnectionPoolBuilder poolSize(int poolSize) {
         return this;
     }
 
-    public ConnectionPool build() {
-        return new NettyPgConnectionPool(properties);
-    }
-    
+    /**
+     * Configuration for a pool.
+     */
     public static class PoolProperties {
 
         String hostname = "localhost";