[#3] .Update fixed readme structure

README.md

@@ -2,26 +2,27 @@
 
 [![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/schwartzmx/gremtune) [![Build Status](https://travis-ci.org/schwartzmx/gremtune.svg?branch=master)](https://travis-ci.org/schwartzmx/gremtune) [![Go Report Card](https://goreportcard.com/badge/github.com/schwartzmx/gremtune)](https://goreportcard.com/report/github.com/schwartzmx/gremtune)
 
+- [ ] **Adjust README --> go-gremlin-cosmos**
+
 gremtune is a fork of [qasaur/gremgo](https://github.com/qasaur/gremgo) with alterations to make it compatible with [AWS Neptune](https://aws.amazon.com/neptune/) which is a "Fast, reliable graph database built for the cloud".
 
 gremtune is a fast, efficient, and easy-to-use client for the TinkerPop graph database stack. It is a Gremlin language driver which uses WebSockets to interface with Gremlin Server and has a strong emphasis on concurrency and scalability. Please keep in mind that gremtune is still under heavy development and although effort is being made to fully cover gremtune with reliable tests, bugs may be present in several areas.
 
-**Modifications were made to `gremgo` in order to "support" AWS Neptune's lack of Gremlin-specific features,  like no support query bindings among others. See differences in Gremlin support here: [AWS Neptune Gremlin Implementation Differences](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-differences.html)**
+**Modifications were made to `gremgo` in order to "support" AWS Neptune's lack of Gremlin-specific features, like no support query bindings among others. See differences in Gremlin support here: [AWS Neptune Gremlin Implementation Differences](https://docs.aws.amazon.com/neptune/latest/userguide/access-graph-gremlin-differences.html)**
+
+## Installation
 
-Installation
-==========
 ```
 go get github.com/schwartzmx/gremtune
 dep ensure
 ```
 
-Documentation
-==========
+## Documentation
 
-* [GoDoc](https://godoc.org/github.com/schwartzmx/gremtune)
+- [GoDoc](https://godoc.org/github.com/schwartzmx/gremtune)
+
+## Example
 
-Example
-==========
 ```go
 package main
 
@@ -61,10 +62,11 @@ func main() {
 }
 ```
 
-Example for streaming the result
-==========
+### Example for streaming the result
+
 Neptune provides 64 values per Response that is why Execute at present provides a [] of Response since it waits for all the responses to be retrieved and then provides it.In ExecuteAsync method it takes a channel to provide the Response as request parameter and provides the Response as and when it is provided by Neptune. The Response are streamed to the caller and once all the Responses are provided the channel is closed.
-go test -v -run ExecuteBulkDataAsync is the cmd to run the testcase) 
+go test -v -run ExecuteBulkDataAsync is the cmd to run the testcase)
+
 ```go
 package main
 
@@ -105,7 +107,7 @@ func main() {
     for asyncResponse = range responseChannel {
         log.Println(fmt.Sprintf("Time it took to get async response: %s response status: %v", time.Since(start), asyncResponse.Response.Status.Code))
         count++
-        
+
         nl := new(BulkResponse)
         datastr := strings.Replace(string(asyncResponse.Response.Result.Data), "@type", "type", -1)
         datastr = strings.Replace(datastr, "@value", "value", -1)
@@ -120,10 +122,10 @@ func main() {
 }
 ```
 
-Authentication
-==========
+### Authentication
+
 The plugin accepts authentication creating a secure dialer where credentials are setted.
-If the server where are you trying to connect needs authentication and you do not provide the 
+If the server where are you trying to connect needs authentication and you do not provide the
 credentials the complement will panic.
 
 ```go
@@ -165,6 +167,6 @@ func main() {
 }
 ```
 
-License
-==========
+## License
+
 See [LICENSE](LICENSE.md)