Merge branch 'develop'

Author: ipfans

README.md

@@ -9,16 +9,50 @@
 Simple ODM wraps mgo with interface.
 
 ## TODO
- - [ ] 0.1.0 release
- - [ ] Test coverage
+ - [x] 0.1.0 release
+ - [ ] Test cgo getoverage
  - [x] Travis-ci support
 
 ## Limits
 
-Do not support complex mongo qurey for now.
+Do not support complex mongo query for now.
 
-More need discovery :/.
+More limits need to discovery :D
+
+All API design may change in the future until reach 1.0
 
 ## Usage
 
-Please check `examples/`.
+```go
+type user struct {
+	ID       bson.ObjectId `bson:"_id,omitempty"`
+	Name     string        `bson:"name"`
+	LastIP   string        `bson:"last_ip"`
+	LastTime time.Time     `bson:"last_time"`
+}
+
+type userSelector struct {
+	ID   *bson.ObjectId   `bson:"_id"`
+	IDs  *[]bson.ObjectId `bson:"_id"`
+	Name *string          `bson:"name"`
+}
+
+func (us *userSelector) Database() string {
+	return "test"
+}
+
+func (us *userSelector) Collection() string {
+	return "users"
+}
+
+func main() {
+	sess, err := mgo.DialWithTimeout("127.0.0.1", 2*time.Second)
+	if err != nil {
+		panic(err)
+	}
+	store := mongo.NewStorage(sess)
+	err = store.Query(&userSelector{}).Insert(user{Name: "hello"})
+	if err != nil {
+		panic(err)
+}
+```

mock/mock.go

@@ -10,12 +10,6 @@ import (
 type Storage interface {
 	Query(Collection) QuerySet
 	Raw(Collection, bson.M) QuerySet
-	// Insert(c Collection, docs ...interface{}) error
-	// Update(filter, update interface{}) error
-	// UpdateAll(filter, update interface{}) (info *mgo.ChangeInfo, err error)
-	// Upsert(filter, update interface{}) (info *mgo.ChangeInfo, err error)
-	// Remove(filter interface{}) error
-	// RemoveAll(filter interface{}) (info *mgo.ChangeInfo, err error)
 }
 
 type mongoStorage struct {