From 1a056c1aff6d525df771aadb80cdfeb3048042fd Mon Sep 17 00:00:00 2001 From: "Stephen McQuay (smcquay)" Date: Thu, 23 Jun 2016 22:22:15 -0700 Subject: [PATCH] clean up docs I don't know if it's as meaningful to have verbose docs where when you can just run the server and see the docs on the front page. Change-Id: I9245044a95b5c0e100e14c718cdc99f560dfa3a5 --- cmd/vaind/main.go | 40 ---------------------------------------- doc.go | 20 ++++++++++++++++++++ vain.go | 3 --- 3 files changed, 20 insertions(+), 43 deletions(-) diff --git a/cmd/vaind/main.go b/cmd/vaind/main.go index 6a32d28..cadc8f0 100644 --- a/cmd/vaind/main.go +++ b/cmd/vaind/main.go @@ -1,43 +1,3 @@ -/* -vaind, a webserver for hosting go get vanity urls. - -The go get command searches for the following header when searching for -packages: - - - -this is simply a service for aggregating a collection of prefix, vcs, and -repo-root tuples, and serving the appropriate header over http. For more -information please refer to the documentation for the go tool found at -https://golang.org/cmd/go/#hdr-Remote_import_paths - -API - -Assume an instance of vaind at example.org. In order to add a package -example.org/foo that points at bitbucket.org/example/foo (a mercurial -repository) POST the following json object: - - { - "vcs": "mercurial", - "repo": "https://bitbucket.org/example/foo" - } - -to https://example.org/foo. - -Doing so, then visiting https://example.org/foo?go-get=1 will yield a header -that looks like: - - - - - -The json object sent to server can have two fields: "repo" and "vcs". "repo" is -required; leaving off the "vcs" member defaults to "git". - -In order to delete a package: - - DELETE / -*/ package main import ( diff --git a/doc.go b/doc.go index 12ee4d2..5016a48 100644 --- a/doc.go +++ b/doc.go @@ -1 +1,21 @@ +/* +Package vain implements a vanity service for use by the the go tool. + + +The executable, cmd/vaind, is located in the respective subdirectory. vaind, +a webserver for hosting go get vanity urls. + +The go get command searches for the following header when searching for +packages: + + + +this is simply a service for aggregating a collection of prefix, vcs, and +repo-root tuples, and serving the appropriate header over http. For more +information please refer to the documentation for the go tool found at +https://golang.org/cmd/go/#hdr-Remote_import_paths + +For instructions on how to use this service, build the daemon, run it, and +visit the root url. +*/ package vain diff --git a/vain.go b/vain.go index bef5346..631f5dc 100644 --- a/vain.go +++ b/vain.go @@ -1,6 +1,3 @@ -// Package vain implements a vanity service for use by the the go tool. -// -// The executable, cmd/vaind, is located in the respective subdirectory. package vain import (