summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Manuel <nilslice@gmail.com>2018-01-21 11:21:25 -0700
committerGitHub <noreply@github.com>2018-01-21 11:21:25 -0700
commitca0b1f44fec5fb944304bf2668623d21bdc01150 (patch)
tree38e6ab32b2b778e8422658b3ed1cb85e5043cc11
parentff3c0f6bcb9d6477d386057dca1b54037b424ddf (diff)
[docs] README.md: update with circle badge and fix docs (#225)
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index 91c6589..cc8e217 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,7 @@
[![Current Release](https://img.shields.io/github/release/ponzu-cms/ponzu.svg)](https://github.com/ponzu-cms/ponzu/releases/latest)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/ponzu-cms/ponzu)
[![Go Report Card](https://goreportcard.com/badge/github.com/ponzu-cms/ponzu)](https://goreportcard.com/report/github.com/ponzu-cms/ponzu)
+[![CircleCI Build Status](https://circleci.com/gh/ponzu-cms/ponzu.svg?style=shield)](https://circleci.com/gh/ponzu-cms/ponzu/tree/master)
> Watch the [**video introduction**](https://www.youtube.com/watch?v=T_1ncPoLgrg)
@@ -51,7 +52,7 @@ For more detailed documentation, check out the [docs](https://docs.ponzu-cms.org
## Installation
```
-$ go get github.com/ponzu-cms/ponzu/...
+$ go get -u github.com/ponzu-cms/ponzu/...
```
## Requirements
@@ -184,7 +185,7 @@ $ ponzu run admin
(or)
$ ponzu run --port=8888 api
(or)
-$ ponzu --dev-https run
+$ ponzu run --dev-https
```
Defaults to `$ ponzu run --port=8080 admin,api` (running Admin & API on port 8080, without TLS)