1
0
forked from sm/vain

ysvd -> vaind

This commit is contained in:
Stephen McQuay 2016-02-16 23:27:53 -08:00
parent cc8e0914b8
commit a1f6e15f28
4 changed files with 11 additions and 15 deletions

View File

@ -1,5 +1,5 @@
/* /*
ysvd, a webserver for hosting go get vanity urls. vaind, a webserver for hosting go get vanity urls.
The go get command searches for the following header when searching for The go get command searches for the following header when searching for
packages: packages:
@ -13,7 +13,7 @@ https://golang.org/cmd/go/#hdr-Remote_import_paths
API API
Assume an instance of ysvd at example.org. In order to add a package 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 example.org/foo that points at bitbucket.org/example/foo (a mercurial
repository) POST the following json object: repository) POST the following json object:
@ -33,10 +33,6 @@ that looks like:
The json object sent to server can have two fields: "repo" and "vcs". "repo" is The json object sent to server can have two fields: "repo" and "vcs". "repo" is
required; leaving off the "vcs" member defaults to "git". required; leaving off the "vcs" member defaults to "git".
Naming
The "ysv" in ysvd stands for You're so Vain, the song by Carly Simon.
*/ */
package main package main
@ -51,13 +47,13 @@ import (
"github.com/kelseyhightower/envconfig" "github.com/kelseyhightower/envconfig"
) )
const usage = `ysvd const usage = `vaind
environment vars: environment vars:
YSV_PORT: tcp listen port VAIN_PORT: tcp listen port
YSV_HOST: hostname to use VAIN_HOST: hostname to use
YSV_DB: path to json database VAIN_DB: path to json database
` `
type config struct { type config struct {

View File

@ -10,7 +10,7 @@ are permitted provided that the following conditions are met:
* Redistributions in binary form must reproduce the above copyright notice, * Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution. and/or other materials provided with the distribution.
* Neither the name of ysv nor the names of its contributors * Neither the name of vaind nor the names of its contributors
may be used to endorse or promote products derived from this software may be used to endorse or promote products derived from this software
without specific prior written permission. without specific prior written permission.

View File

@ -1,11 +1,11 @@
# vain # vain
`ysvd` is a vanity url server for use by the `go` tool. `vaind` is a vanity url server for use by the `go` tool.
## installation ## installation
$ go get mcquay.me/vain/cmd/ysvd $ go get mcquay.me/vain/cmd/vaind
## running server ## running server
$ ysvd $ vaind

View File

@ -1,6 +1,6 @@
// 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.
// //
// The executable, cmd/ysvd, is located in the respective subdirectory. // The executable, cmd/vaind, is located in the respective subdirectory.
package vain package vain
import ( import (