Skip to content
SHOULDERS.md generator
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
shoulders
.gitignore
.gometalinter.json
.goreleaser.yml
.goreleaser.yml.plush
.travis.yml
LICENSE.txt
Makefile
README.md
SHOULDERS.md
go.mod
go.sum
main.go
version.go

README.md

Shoulders

Inspired by the SHOULDERS.md several projects have started to create their own implementations. This tool will create a custom SHOULDERS.md file for any given Go project allowing OSS maintainers to recognize those who's OSS contributions helped them.

Installation

$ go get -u github.com/gobuffalo/shoulders

Usage

When run without any flags the shoulders command will print the SHOULDERS.md to the STDOUT.

$ shoulders
# github.com/gobuffalo/shoulders Stands on the Shoulders of Giants

github.com/gobuffalo/shoulders does not try to reinvent the wheel! Instead, it uses the already great wheels developed by the Go community and puts them altogether in the best way possible. Without these giants, this project would not be possible. Please make sure to check them out and thank them for all of their hard work.

Thank you to the following **GIANTS**:


* [github.com/markbates/deplist](https://godoc.org/github.com/markbates/deplist)

* [github.com/pkg/errors](https://godoc.org/github.com/pkg/errors)

The -w (Write) Flag

To write the SHOULDERS.md file to disk use the -w flag.

$ shoulders -w

The -n (Name) Flag

By default the "name" of the project is the current package name. To change that use the -n flag.

$ shoulders -n Buffalo
# Buffalo Stands on the Shoulders of Giants

Buffalo does not try to reinvent the wheel! Instead, it uses the already great wheels developed by the Go community and puts them altogether in the best way possible. Without these giants, this project would not be possible. Please make sure to check them out and thank them for all of their hard work.

Thank you to the following **GIANTS**:


* [github.com/markbates/deplist](https://godoc.org/github.com/markbates/deplist)

* [github.com/pkg/errors](https://godoc.org/github.com/pkg/errors)

The -j (JSON) Flag

To get a JSON array of the dependencies of the project use the -j flag.

$ shoulders -j
["github.com/markbates/deplist","github.com/pkg/errors"]
You can’t perform that action at this time.