bit more docs

This commit is contained in:
Stephen McQuay 2016-02-11 12:03:03 -08:00
parent b7ef100a2c
commit 158ef57b13
3 changed files with 32 additions and 28 deletions

View File

@ -1,3 +1,8 @@
/*
command ysvd implements the
The "ysv" in ysvd stands for You're so Vain, the song by Carly Simon.
*/
package main
import (

28
doc.go
View File

@ -1,2 +1,28 @@
// package vain implements a vanity service for use by the the go tool
/*
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 /v0/package/
A sample json object:
{
"vcs": "mercurial",
"path": "mcquay.me/vain",
"repo": "https://s.mcquay.me/sm/vain"
}
"path" and "repo" are required; leaving off the "vcs" member defaults to "git".
*/
package vain

27
vain.go
View File

@ -1,30 +1,3 @@
/*
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 /v0/package/
A sample json object:
{
"path": "mcquay.me/vain",
"repo": "https://s.mcquay.me/sm/vain"
}
Naming
the "ysv" in ysvd stands for You're so Vain, the song by Carly Simon.
*/
package vain
import "fmt"