Merge pull request #19 from itsksaurabh/go/doc

add doc.go

client.go

@@ -1,5 +1,3 @@
-// Package wazirx provides wazirx.com's Public Rest API client.
-// You can read the API server documentation at https://github.com/WazirX/wazirx-api
 package wazirx
 
 import (

doc.go

@@ -0,0 +1,34 @@
+/*
+Package wazirx provides a client for using the Wazirx's Public Rest API.
+You can read the API server documentation at https://github.com/WazirX/wazirx-api
+
+Usage:
+
+create a new instance of Client, then use the various methods on the client to access different parts of the API.
+For demonstration:
+  package main
+  import (
+	"context"
+	"fmt"
+	"log"
+
+   	"github.com/itsksaurabh/go-wazirx"
+ )
+
+  func main() {
+	client := wazirx.Client{}
+	ctx := context.Background()
+
+	data, err := client.MarketStatus(ctx)
+	if err != nil {
+		log.Fatal("request failed:", err)
+	}
+	fmt.Println(data)
+  }
+
+Notes:
+* Using the  [https://godoc.org/context](https://godoc.org/context) package for passing context.
+* Look at tests(*_test.go) files for more sample usage.
+
+*/
+package wazirx