yakumo.izuru/toyohime
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update to reflect the current state

Browse Source 
git-svn-id: file:///srv/svn/repo/toyohime/trunk@82 922d331f-388e-da47-97a9-ad700dc0b8b9
This commit is contained in:
jonbetti 2018-06-05 03:09:48 +00:00
parent f00351ef0f
commit 6741b0f62a
1 changed files with 15 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,28 +1,23 @@
# Vanity [![GoDoc](https://godoc.org/go.jonnrb.io/vanity?status.svg)](https://godoc.org/go.jonnrb.io/vanity)
# Vanity [![Build Status](https://travis-ci.org/kare/vanity.svg?branch=master)](https://travis-ci.org/kare/vanity) [![GoDoc](https://godoc.org/kkn.fi/cmd/vanity?status.svg)](https://godoc.org/kkn.fi/vanity)
## Concepts
- VCS is Version Control System (such as Git or Mercurial)
- VCS root is the root path the source code repository (such as github.com/kare)
- Domain is the internet address where the Go Vanity server is hosted (such as
9fans.net or kkn.fi)
- Path is the path component of the Go package (such as /cmd/tcpproxy in
kkn.fi/cmd/tcpproxy)
A vanity import path is any import path that can be downloaded with
`go get` but isn't otherwise blessed by the `go` tool (e.g. GitHub,
BitBucket, etc.). A commonly used vanity import path is
"golang.org/x/...". This package attempts to mimic the behavior of
"golang.org/x/..." as closely as possible.
## Features
- Redirects browsers to godoc.org
- Redirects Go tool to VCS
- Redirects godoc.org to browsable files
- Redirects HTTP to HTTPS
- Automatic configuration of packages:
- All packages are redirected with full path to vcsroot.
- Packages whose path is prefixed with "/cmd/" redirect automatically to
vcsroot by stripping the "/cmd" prefix from the package path.
Example: Redirect request "kkn.fi/cmd/tcpproxy" to "github.com/kare/tcpproxy"
## Installation
```
go get kkn.fi/vanity
```bash
go get go.jonnrb.io/vanity
```
## Specification
- [Go 1.4 Custom Import Path Checking](https://docs.google.com/document/d/1jVFkZTcYbNLaTxXD9OcGfn7vYv5hWtPx9--lTx1gPMs/edit)
- [Remote Import Paths](https://golang.org/cmd/go/#hdr-Remote_import_paths)
- [GDDO Source Code Links](https://github.com/golang/gddo/wiki/Source-Code-Links)
- [Custom Import Path Checking](https://docs.google.com/document/d/1jVFkZTcYbNLaTxXD9OcGfn7vYv5hWtPx9--lTx1gPMs/edit)