doc: add readme sections (#4)

* doc: add readme sections

* fix: add missing toc and contribute section

* fix: Typescript -> Node

README.md

@@ -4,3 +4,118 @@
 <!-- prettier-ignore-end -->
 
 # mgod
+
+`mgod` is a MongoDB ODM specifically designed for Go. It provides a structured way to map Go models to MongoDB collections, simplifying database interactions in Go applications.
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+- [Motivation](#motivation)
+- [Future Scope](#future-scope)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Features
+- **Reuse existing Go structs** to define models and perform Mongo operations.
+- Automatic **field transformation** between Go and MongoDB using struct tags.
+- Easily manage **meta fields** in models without cluttering Go structs.
+- Supports **union types**, expanding data capabilities.
+- Implement strict field requirements with struct tags for **data integrity**.
+- Wrapper around the **official** Mongo Go Driver.
+
+## Requirements
+- Go 1.18 or higher.
+- MongoDB 3.6 and higher.
+
+## Installation
+```
+go get github.com/Lyearn/mgod
+```
+
+## Basic Usage
+Add tags _(wherever applicable)_ in existing struct _(or define a new model)_.
+```go
+type User struct {
+	Name     string
+	EmailID  string `bson:"emailId"`
+	Age      *int32 `bson:",omitempty"`
+	JoinedOn string `bson:"joinedOn" mgoType:"date"`
+}
+```
+
+Use `mgod` to get the entity ODM.
+```go
+import (
+	"github.com/Lyearn/mgod"
+	"github.com/Lyearn/mgod/schema/schemaopt"
+)
+
+model := User{}
+schemaOpts := schemaopt.SchemaOptions{
+	Collection: "users",
+	Timestamps: true,
+}
+
+// dbConn is the database connection obtained using Go Mongo Driver's Connect method.
+userModelOpts := mgod.NewEntityMongoOptions(dbConn).SetSchemaOptions(schemaOpts)
+userModel, _ := mgod.NewEntityMongoModel(model, *userModelOpts)
+```
+
+Use the entity ODM to perform CRUD operations with ease.
+```go
+// Insert new document.
+joinedOn, _ := dateformatter.New(time.Now()).GetISOString()
+userDoc := User{
+	Name: "Gopher",
+	EmailID: "gopher@mgod.com",
+	JoinedOn: joinedOn,
+}
+userModel.InsertOne(context.TODO(), userDoc)
+/*
+{
+	"_id": ObjectId("65697705d4cbed00e8aba717"),
+	"name": "Gopher",
+	"emailId": "gopher@mgod.com",
+	"joinedOn": "2023-12-01 11:32:19.290Z",
+	"createdAt": "2023-12-01 11:32:19.290Z",
+	"__v": 0
+}
+*/
+
+// Find documents using model properties.
+users, _ := userModel.Find(context.TODO(), bson.M{"name": userDoc.Name})
+/*
+[]User{
+	User{
+		Name: "Gopher",
+		EmailID: "gopher@mgod.com",
+		JoinedOn: "2023-12-01T11:32:19.290Z",
+	}
+}
+*/
+```
+
+## Motivation
+Creating `mgod` was driven by the need to **simplify MongoDB interactions** while keeping **one schema for all** in Go. Traditionally, working with MongoDB in Go involved either using separate structs for database and service logic or manually converting service structs to MongoDB documents, a process that was both time-consuming and error-prone. This lack of integration often led to redundant coding, especially when dealing with union types or adding meta fields for each MongoDB operation.
+
+Inspired by the easy interface of MongoDB handling using [Mongoose](https://github.com/Automattic/mongoose) and [Typegoose](https://github.com/typegoose/typegoose) libraries available in Node, `mgod` aims to streamline these processes. It offers a more integrated approach, reducing the need to duplicate code and enhancing type safety, making MongoDB operations more intuitive and efficient in Go.
+
+## Future Scope
+The current version of mgod is a stable release. However, there are plans to add a lot more features like -
+- [ ] Enable functionality to opt out of the default conversion of date fields to ISOString format.
+- [ ] Implement a setup step for storing a default Mongo connection, eliminating the need to pass it during EntityMongoModel creation.
+- [ ] Provide support for transactions following the integration of default Mongo connection logic.
+- [ ] Develop easy to use wrapper functions around MongoDB Aggregation operation.
+- [ ] Introduce automatic MongoDB collection selection based on Go struct names as a default behavior.
+- [ ] Add test cases to improve code coverage.
+
+If you have any interesting feature requests, feel free to open an issue on [GitHub issue tracker](https://github.com/Lyearn/mgod/issues). We will be more than happy to discuss that!
+
+## Contribute
+For contribution guidelines, check out [CONTRIBUTING](https://github.com/Lyearn/mgod/blob/main/CONTRIBUTING.md).
+
+<!-- ## Documentation -->
+
+## License
+`mgod` is licensed under the [MIT License](https://github.com/Lyearn/mgod/blob/main/LICENSE).

entity_mongo_model_test.go

@@ -70,11 +70,13 @@ func (s *EntityMongoModelSuite) TestFind() {
 		firstID := primitive.NewObjectID()
 		secondID := primitive.NewObjectID()
 
+		//nolint:govet // this is a mock entity.
 		firstEntity := TestEntity{
 			ID:       firstID.Hex(),
 			Name:     "test1",
 			JoinedOn: currentTimeStr,
 		}
+		//nolint:govet // this is a mock entity.
 		secondEntity := TestEntity{
 			ID:       secondID.Hex(),
 			Name:     "test2",
@@ -119,6 +121,7 @@ func (s *EntityMongoModelSuite) TestFindOne() {
 
 		id := primitive.NewObjectID()
 
+		//nolint:govet // this is a mock entity.
 		entity := TestEntity{
 			ID:       id.Hex(),
 			Name:     "test",

go.mod

@@ -1,6 +1,6 @@
 module github.com/Lyearn/mgod
 
-go 1.21.0
+go 1.18
 
 require (
 	github.com/samber/lo v1.38.1

go.sum

@@ -6,7 +6,6 @@ github.com/golang/snappy v0.0.4 h1:yAGX7huGHXlcLOEtBnF4w7FQwA26wojNCwOYAEhLjQM=
 github.com/golang/snappy v0.0.4/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
-github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/klauspost/compress v1.13.6/go.mod h1:/3/Vjq9QcHkK5uEr5lBEmyoZ1iFhe47etQ6QUkpK6sk=
 github.com/klauspost/compress v1.16.7 h1:2mk3MPGNzKyxErAw8YaohYh69+pa4sIQSC0fPGCFR9I=
 github.com/klauspost/compress v1.16.7/go.mod h1:ntbaceVETuRiXiv4DpjP66DpAtAGkEQskQzEyD//IeE=