Permalink
Browse files

Added a README.

  • Loading branch information...
1 parent 08e03ab commit 8486a7cf1e785d2922314ceb06547bc7798d40fd @dustin dustin committed Jan 21, 2012
Showing with 29 additions and 0 deletions.
  1. +29 −0 README.markdown
View
@@ -0,0 +1,29 @@
+# A smart client for couchbase in go
+
+This is an evolving package, but does provide a useful interface to a
+[couchbase](http://www.couchbase.com/) server including all of the
+pool/bucket discovery features, compatible key distribution with other
+clients, and vbucket motion awareness so application can continue to
+operate during rebalances.
+
+It also supports view querying with source node randomization so you
+don't bang on all one node to do all the work.
+
+## Example
+
+ c, err := couchbase.Connect("http://dev-couchbase.example.com:8091/")
+ if err != nil {
+ log.Fatalf("Error connecting: %v", err)
+ }
+
+ pool, err := c.GetPool("default")
+ if err != nil {
+ log.Fatalf("Error getting pool: %v", err)
+ }
+
+ bucket, err := pool.GetBucket("default")
+ if err != nil {
+ log.Fatalf("Error getting bucket: %v", err)
+ }
+
+ bucket.Set("someKey", []string{"an", "example", "list"})

0 comments on commit 8486a7c

Please sign in to comment.