-
Type: Improvement
-
Resolution: Fixed
-
Priority: Major - P3
-
Affects Version/s: None
-
Component/s: Documentation
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