fleshed out where documentation is stored.

2016-02-15 01:09:11 -08:00
parent 83f08830b9
commit c5c1dbc4a9
2 changed files with 36 additions and 27 deletions
@@ -1,27 +1 @@
-/*
-Package vain implements a vanity service for use by the the go tool
-
-From the documentation for the go tool, it searches for the following header
-when searching for packages:
-
-	<meta name="go-import" content="import-prefix vcs repo-root">
-
-this is simply a service for aggregating a collection of prefix, vcs, and
-repo-root tuples, and serving the appropriate header over http.
-
-API
-
-In order to add a new package POST a json object to the following route:
-
-	POST /
-
-A sample json object:
-
-	{
-		"vcs": "mercurial",
-		"repo": "https://s.mcquay.me/sm/vain"
-	}
-
-"repo" is required; leaving off the "vcs" member defaults to "git".
-*/
 package vain