diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 21 |
1 files changed, 19 insertions, 2 deletions
@@ -1,7 +1,24 @@ # sally -A canonical import path static site generator for Go +A tiny HTTP server for supporting custom Golang import paths ## Installation -`go get -u go.uber.org/sally` +`go get go.uber.org/sally` + +## Usage + +Create a YAML file with the following structure: + +```yaml +url: google.golang.org +packages: + grpc: + repo: github.com/grpc/grpc-go +``` + +Then run Sally to start the HTTP server: + +``` +$ sally -yml site.yaml -port 5000 +``` |