Permalink
Browse files

Update README.rst

  • Loading branch information...
1 parent f662081 commit 62bd5e80409c0d0643a4021a94af42c784df33a7 @lanwin lanwin committed Sep 26, 2010
Showing with 34 additions and 37 deletions.
  1. +34 −37 README.rst
View
@@ -1,66 +1,63 @@
MongoDB-CSharp
==============
-This is a community supported release of a driver to connect to MongoDB using .Net. It is written entirely in C# and has been tested and developed under both Windows and Mono 2.0 (Ubuntu 32-bit 9.04). Currently many features have been implemented with a few remaining. The api is very likely to change and be in flux for a while but is quickly settling down. At this point it is becoming a solid base to add many more advanced features.
+This is a community supported driver to connect to MongoDB using .Net. It is written entirely in C# and has been tested and developed under both Windows and Mono 2.0 (Ubuntu 32-bit 9.04). Its API is similar to the Mongo Client one. At this point it is becoming a solid base to add many more advanced features.
-Current Features
+Home: http://github.com/mongodb-csharp/mongodb-csharp
+
+A few of its Features
================
-- Connect to a server.
-- Query
-- Insert
-- Update
-- Delete
-- All BSON types supported
-- DBRef support
+- All BSON types supported + DBRef
- Isolation and conversion between BSON types and native .net types.
-- Database, Collection and Cursor objects.
+- Query,Insert,Update,Delete
+- Connection Pooling
+- Typed Collections + Mapping
+- Linq support
- Index handling routines (List, Create, Drop)
-- Count
-- Roughly 80% unit test coverage. This can and will be improved on.
-- Paired connections
-- Authentication (Does not reauthorize on auto reconnect yet).
+- Connection Strings
+- Authentication
- Database Commands
-- Basic Linq support
- GridFS support
-- Map Reduce helpers.
-- hint, explain, $where
+- Map Reduce support
+- Count, Hint, Explain, $where
- Safemode
-- Exceptions
-- Connection Pooling
-Missing Features
-================
-- Auto reconnect options
-- database profiling: set/get profiling level, get profiling info
-- Many unit tests
+Downloads
+============
+The latest binary version can be found here: http://github.com/mongodb-csharp/mongodb-csharp/downloads
+The source related to that versions can be found on that page at the bottom.
Installation
============
-Currently using the driver in the GAC is not supported. Simply copy the driver assembly somewhere and reference it in your project. It should be deployed in your application's bin directory. It is not necessary to use the test assembly.
+Simply copy the driver assembly somewhere and reference it in your project. It should be deployed in your application's bin directory. It is not necessary to use the test assembly.
Patches
=======
-Patches are welcome and will likely be accepted. By submitting a patch you assign the copyright to me, Sam Corder. This is necessary to simplify the number of copyright holders should it become necessary that the copyright need to be reassigned or the code relicensed. The code will always be available under an OSI approved license.
+Patches are welcome and will likely be accepted. By submitting a patch you assign the copyright to me, Sam Corder. This is necessary to simplify the number of copyright holders should it become necessary that the copyright need to be reassigned or the code relicensed. The code will always be available under an OSI approved license.
-A bug fix patch should contain a test case that reproduces the issue along with the actual fix. Try to follow the same style that the code is already in so that things remain clean. Keep your whitespace settings the same as the code to make reading and applying diffs manageable. We use 4 spaces for tabs and Windows line endings.
+A bug fix patch should contain a test case that reproduces the issue along with the actual fix. Try to follow the same style that the code is already in so that things remain clean. Keep your whitespace settings the same as the code to make reading and applying diffs manageable We use 4 spaces for tabs and Windows line endings.
-Usage
+Getting Started
=====
-One of the best sources for how to use the driver is the unit tests. Basic usage can be found in the TestCollection set of test cases.
+The best point to start is our Wiki at http://github.com/mongodb-csharp/mongodb-csharp/wiki There is also a FAQ section where you should look if you have problems.
+Another good source for how to use the driver is its unit tests. Basic usage can be found in the TestCollection set of test cases.
At the simplest query the database like this:
- using MongoDB.Driver;
- Mongo db = new Mongo();
- db.Connect(); //Connect to localhost on the default port.
- Document query = new Document();
- query["field1"] = 10;
- Document result = db["tests"]["reads"].FindOne(query);
- db.Disconnect();
+ using MongoDB;
+ using(Mongo mongo = new Mongo("localhost"))
+ {
+ mongo.Connect();
+ var database = mongo.GetDatabase("database");
+ var collection = database.GetCollecton("collection");
+ //or short collection= mongo["database"]["collection"]
+ Document result = collection.FindOne(new Document("field1",10));
+ Console.WriteLine(result["value"]);
+ }
There is also a growing number of samples in the examples directory.
Getting Help
============
-The Google Group mongodb-csharp at (http://groups.google.com/group/mongodb-csharp) is the best place to go.
+The Google Group MongoDB-CSharp at (http://groups.google.com/group/mongodb-csharp) is the best place to go.
Reporting Bugs
==============

0 comments on commit 62bd5e8

Please sign in to comment.