Skip to content

Commit 3d25f66

Browse files
committed
Doc update
1 parent f94566a commit 3d25f66

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package renderer
22
==================
33
[![Build Status](https://travis-ci.org/thedevsaddam/renderer.svg?branch=master)](https://travis-ci.org/thedevsaddam/renderer)
4-
[![Project status](https://img.shields.io/badge/version-1.0-green.svg)](https://github.com/thedevsaddam/renderer/releases)
4+
[![Project status](https://img.shields.io/badge/version-1.1-green.svg)](https://github.com/thedevsaddam/renderer/releases)
55
[![Go Report Card](https://goreportcard.com/badge/github.com/thedevsaddam/renderer)](https://goreportcard.com/report/github.com/thedevsaddam/renderer)
66
[![Coverage Status](https://coveralls.io/repos/github/thedevsaddam/renderer/badge.svg?branch=master)](https://coveralls.io/github/thedevsaddam/renderer?branch=master)
77
[![GoDoc](https://godoc.org/github.com/thedevsaddam/renderer?status.svg)](https://godoc.org/github.com/thedevsaddam/renderer)
@@ -56,6 +56,11 @@ func main() {
5656
rnd.NoContent(w)
5757
})
5858

59+
// serving string as html
60+
mux.HandleFunc("/html-string", func(w http.ResponseWriter, r *http.Request) {
61+
rnd.HTMLString(w, http.StatusOK, "<h1>Hello Renderer!</h1>")
62+
})
63+
5964
// serving JSON
6065
mux.HandleFunc("/json", func(w http.ResponseWriter, r *http.Request) {
6166
rnd.JSON(w, http.StatusOK, usr)

renderer.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ func (r *Render) YAML(w http.ResponseWriter, status int, v interface{}) error {
366366
return err
367367
}
368368

369-
// HTMLString render string as html
369+
// HTMLString render string as html. Note: You must provide trusted html when using this method
370370
func (r *Render) HTMLString(w http.ResponseWriter, status int, html string) error {
371371
w.Header().Set(ContentType, r.opts.ContentHTML)
372372
w.WriteHeader(status)

0 commit comments

Comments
 (0)