From ac8374fd17e30fca9a7773a2a6f690a7ea4d2ec9 Mon Sep 17 00:00:00 2001 From: Grayson Koonce Date: Wed, 12 Oct 2016 11:04:26 -0700 Subject: Rework as HTTP server (#15) --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 65577be..51527ed 100644 --- a/README.md +++ b/README.md @@ -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 +``` -- cgit v1.2.3