Code

Fixed compatibility issues with Go 1.0 and 1.1.
[sysdb/go.git] / README
diff --git a/README b/README
index 0dbe76d86a3aec5ac133104d53cbc1108a219295..ccf9da14e6a5b73ebde84941badfdc8a80d6a89e 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,8 @@
-                           Core Go bindings for SysDB
-                          ============================
+                      Core Go language bindings for SysDB
+                     =====================================
 
-  The core Go bindings for SysDB are a set of packages for the Go programming
-  language providing core functionality to interact with SysDB.
+  The core Go language bindings for SysDB are a set of packages for the Go
+  programming language providing core functionality to interact with SysDB.
 
 What is SysDB?
 --------------
@@ -54,6 +54,16 @@ Packages
     protocol. That's the protocol used for communication between a client and
     a SysDB server instance.
 
+  * github.com/sysdb/go/sysdb: Core constants and types used by SysDB
+    packages.
+
+Documentation
+-------------
+
+  The documentation for all Go packages is included with the source code in a
+  way compatible with the godoc tool. As such, it can be viewed and browsed
+  online at <https://godoc.org/github.com/sysdb/go>.
+
 Getting Help
 ------------