change to godoc

matthewmueller · Dec 12, 2017 · 5607ec3 · 5607ec3
1 parent 0fb7e09
commit 5607ec3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/Readme.md b/Readme.md
@@ -6,13 +6,13 @@ Visit [mat.tm/joy](https://mat.tm/joy) to learn more about Joy.
 
 ---
 
-[Getting Started]()
-&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[Examples]()
-&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[Using the CLI]()
+[Getting Started](#getting-started)
+&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[Examples](#examples)
+&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[Using the CLI](#using-the-cli)
 
-<!-- [JOY API]()&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[DOM API]()&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[Virtual DOM API]() -->
+[Joy API](https://godoc.org/github.com/matthewmueller/joy)&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[DOM API](https://godoc.org/github.com/matthewmueller/joy/dom)&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[Virtual DOM API](https://godoc.org/github.com/matthewmueller/joy/vdom)
 
-[Contributing]()&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[FAQ]()&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[More Links]()
+[Contributing](#contributing)&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[FAQ](#faq)&nbsp;&nbsp;&nbsp;&nbsp;&#183;&nbsp;&nbsp;&nbsp;&nbsp;[More Links](#more-links)
 
 ---
 

diff --git a/dom/doc.go b/dom/doc.go
@@ -0,0 +1,4 @@
+// Package dom implements the Joy bindings for a 100% complete, zero-cost DOM.
+//
+// Please note that these APIs are still experimental and may change significantly before we reach 1.0
+package dom
diff --git a/vdom/doc.go b/vdom/doc.go
@@ -0,0 +1,4 @@
+// Package vdom implements the Joy bindings for a 100% complete, zero-cost DOM.
+//
+// Please note that these APIs are still experimental and may change significantly before we reach 1.0
+package vdom