summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mattn/godown/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/mattn/godown/README.md')
-rw-r--r--vendor/github.com/mattn/godown/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/vendor/github.com/mattn/godown/README.md b/vendor/github.com/mattn/godown/README.md
new file mode 100644
index 00000000..a94f4157
--- /dev/null
+++ b/vendor/github.com/mattn/godown/README.md
@@ -0,0 +1,42 @@
+# godown
+
+[![Build Status](https://travis-ci.org/mattn/godown.png?branch=master)](https://travis-ci.org/mattn/godown)
+[![Codecov](https://codecov.io/gh/mattn/godown/branch/master/graph/badge.svg)](https://codecov.io/gh/mattn/godown)
+[![GoDoc](https://godoc.org/github.com/mattn/godown?status.svg)](http://godoc.org/github.com/mattn/godown)
+[![Go Report Card](https://goreportcard.com/badge/github.com/mattn/godown)](https://goreportcard.com/report/github.com/mattn/godown)
+
+Convert HTML into Markdown
+
+This is work in progress.
+
+## Usage
+
+```
+err := godown.Convert(w, r)
+checkError(err)
+```
+
+
+## Command Line
+
+```
+$ godown < index.html > index.md
+```
+
+## Installation
+
+```
+$ go get github.com/mattn/godown/cmd/godown
+```
+
+## TODO
+
+* escape strings in HTML
+
+## License
+
+MIT
+
+## Author
+
+Yasuhiro Matsumoto (a.k.a. mattn)