diff --git a/README.md b/README.md index ab37e4c..c2b037c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ # Go Vanity URLs -Go Vanity URLs is a simple App Engine Go app that allows you +Go Vanity URLs is a simple Go server that allows you to set custom import paths for your Go packages. +It also can run on Google App Engine. ## Quickstart +Install and run the binary: + +``` +$ go get -u https://github.com/GoogleCloudPlatform/govanityurls +$ # update vanity.yaml +$ govanityurls +``` + + +### Google App Engine + Install [gcloud](https://cloud.google.com/sdk/downloads) and install Go App Engine component: ```