Add contribution instructions
git-svn-id: file:///srv/svn/repo/toyohime/trunk@84 922d331f-388e-da47-97a9-ad700dc0b8b9
This commit is contained in:
parent
7d3e0272ad
commit
7669f77df1
14
README.md
14
README.md
@ -7,17 +7,25 @@ BitBucket, etc.). A commonly used vanity import path is
|
||||
"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
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get go.jonnrb.io/vanity
|
||||
```
|
||||
|
||||
## Specification
|
||||
- [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)
|
||||
|
||||
- [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)
|
||||
|
||||
## Contributing
|
||||
|
||||
Shoot me an email with a repo and branch to pull (or even better, use
|
||||
[git-request-pull](https://git-scm.com/docs/git-request-pull)).
|
||||
|
Loading…
x
Reference in New Issue
Block a user