aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Grayson Koonce <grayson.koonce@gmail.com> 2016-10-12 11:04:26 -0700
committerGravatar GitHub <noreply@github.com> 2016-10-12 11:04:26 -0700
commitac8374fd17e30fca9a7773a2a6f690a7ea4d2ec9 (patch)
treee9a61adde4bc5eef80583f3e1d6f9379a20b4f99 /README.md
parentb80c4f3e920994823061eb05dc0a5bc3881ddb02 (diff)
downloadsally-ac8374fd17e30fca9a7773a2a6f690a7ea4d2ec9.tar.gz
sally-ac8374fd17e30fca9a7773a2a6f690a7ea4d2ec9.tar.zst
sally-ac8374fd17e30fca9a7773a2a6f690a7ea4d2ec9.zip
Rework as HTTP server (#15)
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 19 insertions, 2 deletions
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
+```