Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated Readme with build instructions

Change-Id: I523f2496b9d3b774bcbcfc8de7f73c05b61b93c3
Reviewed-on: http://review.couchbase.org/13192
Tested-by: John C. Zablocki <john@couchbase.com>
Tested-by: Matt Ingenthron <matt@couchbase.com>
Reviewed-by: Matt Ingenthron <matt@couchbase.com>
  • Loading branch information...
commit d625064107a7b624f8e47149cc956cacea2d25e1 1 parent 6d39476
@johnzablocki johnzablocki authored ingenthr committed
Showing with 46 additions and 0 deletions.
  1. +46 −0 Readme.mdown
View
46 Readme.mdown
@@ -0,0 +1,46 @@
+# Couchbase .NET Client Library
+
+This is a .NET client library for [Couchbase Server](http://couchbase.com).
+
+## Features:
+
+The client currently provides support for Couchbase Server 1.8.
+
+* Understands both the binary and text protocols
+* Highly configurable and extendable (custom configuration, serialization)
+* Supports consistent hashing
+* CheckAndSet operations
+* Persistent connections for more speed
+* SASL Authentication
+
+## Requirements
+
+You'll need .NET Framework 3.5 or later to use the precompiled binaries. To build client, you'll need Visual Studio 2010.
+
+## Building the Client
+
+The client has a dependency on [Enyim.Memcached](https://github.com/enyim/EnyimMemcached), which is included via a git submodule.
+
+ git clone https://<your-user-name>@github.com/couchbase/couchbase-net-client
+ cd couchbase-net-client
+ git submodule init
+ git submodule update
+
+Note also that Enyim.Memcached is delay signed, which means you'll receive exceptions when trying to run your projects from Visual Studio. To work around this security measure locally, you could either disable assembly verification for Enyim.Memcached or modify the project files locally.
+
+To disable assembly verification open the Visual Studio Command Prompt (2010) and run the command below. Note you must run this command as an administrator because it will modify a setting in the registry.
+
+ sn -Vr *,cec98615db04012e
+
+To modify the project files:
+
+* In Visual Studio 2010, open the property pages for Enyim.Caching (Right Click on the project -> Properties or Alt + Enter when the project is highlighted)
+* Select "Signing" from the left hand menu and uncheck "Sign the Assembly"
+* Open the "CommonProperties.targets" which is located in the "build" directory, which is a sibling to the "Enyim.Caching" directory
+* Comment out or remove the last three "PropertyGroup" blocks
+
+## Getting Help
+
+For help with the Couchbase .NET Client Library see the [Couchbase SDK Forums](http://www.couchbase.com/forums/sdks/sdks).
+
+
Please sign in to comment.
Something went wrong with that request. Please try again.