[GODRIVER-574] Update README.md Created: 19/Sep/18  Updated: 28/Oct/23  Resolved: 07/Dec/18

Status: Closed
Project: Go Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 0.1.0

Type: Improvement Priority: Major - P3
Reporter: Kristofer Brandow (Inactive) Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: beta
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: GoDocs for 1.0

 Description   

Go libraries usually have a thorough README file that explains the driver, how to use it, and provides some code examples. This is useful for beginners to the driver since it provides an easy way to start with the driver. For the beta release, update the README with information about how to get the code and use it in an application. Move information about running tests and other contribution information to the CONTRIBUTING file.

Below are examples of useful README files:

https://github.com/boltdb/bolt/blob/master/README.md

https://github.com/couchbase/moss/blob/master/README.md

https://github.com/go-sql-driver/mysql/blob/master/README.md

 


Generated at Thu Feb 08 08:34:30 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.