github: enhance Github documentation as example for Nitdoc README files

[nit.git] / lib / github / github.nit

diff --git a/lib/github/github.nit b/lib/github/github.nit
index 778f826..d4d5904 100644 (file)
--- a/lib/github/github.nit
+++ b/lib/github/github.nit
@@ -12,7 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Github API related features.
+# Nit wrapper for Github API
+#
+# This module provides a Nit object oriented interface to access the
+# [Github api](https://developer.github.com/v3/).
 module github
 
-import api
+import cache