docc

docc open your project GitHub page or README.

Usage

docc try to open your github page by Browser:

$ docc
$ docc /path/to/project

If you want to open project README.md by $EDITOR:

$ docc -e
$ docc -e /path/to/project

Configuration

You can set command to open README.md in ~/.gitconfig.

For example, if you want to use more:

[docc]
    cmd = more

Then execute with -c option:

$ docc -c
$ docc -c /path/to/project

Install

$ brew tap tcnksm/docc
$ brew install docc

VS.

• motemen/git-browse-remote - Extension of git command. It support opening branch/tag page ("ref" mode) and commit page ("rev" mode). docc is not git extension. docc aim to refer documentation(Github page or README).

Contribution

1. Fork (https://github.com/tcnksm/docc/fork)
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test command and confirm that it passes
6. Run gofmt -s
7. Create new Pull Request

You can get source with go get:

$ go get -d github.com/dotcloud/docker
$ go get github.com/tcnksm/docc

Author

tcnksm