diff options
| author | Steve Manuel <nilslice@gmail.com> | 2017-01-03 18:35:29 -0800 |
|---|---|---|
| committer | Steve Manuel <nilslice@gmail.com> | 2017-01-03 18:35:29 -0800 |
| commit | 1b1a06b6ec616b7973eb5dc910f3d6dc50329b31 (patch) | |
| tree | 7449f2145bd31849cec997569920d9235eb88f4a | |
| parent | c1d9ac15acdc9ea2f389cfcd8eee2ac7db291f87 (diff) | |
adding link to Wiki
| -rw-r--r-- | README.md | 5 | ||||
| -rw-r--r-- | system/addon/api.go | 2 | ||||
| -rw-r--r-- | system/item/item.go | 8 |
3 files changed, 9 insertions, 6 deletions
@@ -10,13 +10,16 @@ modern applications. Ponzu is released under the BSD-3-Clause license (see LICENSE). (c) 2016 Boss Sauce Creative, LLC +## Wiki +For more detailed information, check out the [wiki](https://github.com/ponzu-cms/ponzu/wiki) + ## Installation ``` $ go get github.com/ponzu-cms/ponzu/... ``` -### Requirements +## Requirements Go 1.8+ Since HTTP/2 Server Push is used, Go 1.8+ is required. However, it is not diff --git a/system/addon/api.go b/system/addon/api.go index 7167202..9b54d6e 100644 --- a/system/addon/api.go +++ b/system/addon/api.go @@ -12,7 +12,7 @@ import ( "github.com/ponzu-cms/ponzu/system/db" ) -// QueryOptions is a miror of the same struct in db package and are re-declared +// QueryOptions is a mirror of the same struct in db package and are re-declared // here only to make the API simpler for the caller type QueryOptions db.QueryOptions diff --git a/system/item/item.go b/system/item/item.go index 761b2cf..e631b36 100644 --- a/system/item/item.go +++ b/system/item/item.go @@ -12,10 +12,10 @@ import ( "golang.org/x/text/unicode/norm" ) -// Sluggable makes a struct locatable by URL with it's own path +// Sluggable makes a struct locatable by URL with it's own path. // As an Item implementing Sluggable, slugs may overlap. If this is an issue, -// make your content struct (or one which imbeds Item) implement Sluggable -// and it will override the slug created by Item's SetSlug with your struct's +// make your content struct (or one which embeds Item) implement Sluggable +// and it will override the slug created by Item's SetSlug with your own type Sluggable interface { SetSlug(string) ItemSlug() string @@ -62,7 +62,7 @@ type Hideable interface { // Pushable lets a user define which values of certain struct fields are // 'pushed' down to a client via HTTP/2 Server Push. All items in the slice -// should be the json tag names of the struct fields to which they coorespond +// should be the json tag names of the struct fields to which they coorespond. type Pushable interface { // the values contained by fields returned by Push must strictly be URL paths Push() []string |