toyohime/README.md
kare.nuorteva b751b4dc57 Rework internal structure
git-svn-id: file:///srv/svn/repo/toyohime/trunk@35 922d331f-388e-da47-97a9-ad700dc0b8b9
2017-04-24 17:29:37 +00:00

29 lines
884 B
Markdown

# Vanity [![Build Status](https://travis-ci.org/kare/vanity.svg?branch=master)](https://travis-ci.org/kare/vanity) [![GoDoc](https://godoc.org/kkn.fi/vanity?status.svg)](https://godoc.org/kkn.fi/vanity) [![Go Report Card](https://goreportcard.com/badge/kkn.fi/vanity/cmd/vanity)](https://goreportcard.com/report/kkn.fi/vanity/cmd/vanity)
## Features
- Redirects browsers to godoc.org
- Redirects Go tool to VCS
## Installation
```
go get kkn.fi/cmd/vanity
```
## Configuration
Configuration example for Gorilla project:
```
/context git https://github.com/gorilla/context
/mux git https://github.com/gorilla/mux
```
## Running
Script to run Gorilla toolkit's vanity domain server:
```
vanity -d gorillatoolkit.org -c vanity.conf
```
## Specification
- [Go 1.4 Custom Import Path Checking](https://docs.google.com/document/d/1jVFkZTcYbNLaTxXD9OcGfn7vYv5hWtPx9--lTx1gPMs/edit)