commit f6fa0fc23ebb30e749ec86de263176c86fbc2055
author Dmitri Shuralyov <shurcooL@gmail.com> Wed Dec 11 22:09:34 2013 -0800
committer Gary Burd <gary@beagledreams.com> Mon Feb 24 11:31:00 2014 -0800
tree c571815edcf6f381a84ca20a9757f3713dd2251e
parent 66759cfb20c5059a7141fa9c70ca83eae9abf18d

Adds two more API endpoints to README.

Closes #109.

README.markdown

diff --git a/README.markdown b/README.markdown
index 001be7e..2b2b86e 100644
--- a/README.markdown
+++ b/README.markdown
@@ -42,7 +42,24 @@
 
 The GoDoc API is comprised of these endpoints:
 
-**api.godoc.org/importers/`ImportPath`**—Returns packages that import ImportPath, in JSON format.
+**api.godoc.org/search?q=`Query`**—Returns search results for Query, in JSON format.
+
+```json
+{
+	"results": [
+		{
+			"path": "import/path/one",
+			"synopsis": "Package synopsis is here, if present."
+		},
+		{
+			"path": "import/path/two",
+			"synopsis": "Package synopsis is here, if present."
+		}
+	]
+}
+```
+
+**api.godoc.org/packages**—Returns all indexed packages, in JSON format.
 
 ```json
 {
@@ -52,24 +69,52 @@
 		},
 		{
 			"path": "import/path/two"
+		},
+		{
+			"path": "import/path/three"
 		}
 	]
 }
 ```
 
-**api.godoc.org/search?q=`Query`**—Returns search results for Query, in JSON format.
+**api.godoc.org/importers/`ImportPath`**—Returns packages that import ImportPath, in JSON format. Not recursive, direct imports only.
 
 ```json
 {
 	"results": [
 		{
 			"path": "import/path/one",
-			"synopsis": "Package synopsis is here."
+			"synopsis": "Package synopsis is here, if present."
 		},
 		{
 			"path": "import/path/two",
-			"synopsis": "Package synopsis is here."
+			"synopsis": "Package synopsis is here, if present."
 		}
 	]
 }
 ```
+
+**api.godoc.org/imports/`ImportPath`**—Returns packages that ImportPath imports, in JSON format. Not recursive, direct imports only.
+
+```json
+{
+	"imports": [
+		{
+			"path": "import/path/one",
+			"synopsis": "Package synopsis is here, if present."
+		},
+		{
+			"path": "import/path/two",
+			"synopsis": "Package synopsis is here, if present."
+		}
+	],
+	"testImports": [
+		{
+			"path": "import/path/three",
+			"synopsis": "Package synopsis is here, if present."
+		}
+	]
+}
+```
+
+A plain text interface is documented at <http://godoc.org/-/about>.