- [+] update README

1 files changed, 92 insertions, 0 deletions

diff --git a/README.e.md b/README.e.md
new file mode 100644
index 0000000..247ab69
--- /dev/null
+++ b/README.e.md
@@ -0,0 +1,92 @@
+
+{{render "license/shields" . "License" "MIT"}}
+{{template "badge/godoc" .}}
+{{template "badge/goreport" .}}
+{{template "badge/travis" .}}
+[![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-R.svg)](http://godoc.org/github.com/go-easygen/wireframe)
+
+# {{toc 5}}
+
+# {{.Name}} - HTML to Markdown converter
+
+The `{{.Name}}` makes use of `github.com/JohannesKaufmann/html-to-markdown`
+to convert HTML into Markdown, which is using an [HTML Parser](https://github.com/PuerkitoBio/goquery) to avoid the use of `regexp` as much as possible, which can prevent some [weird cases](https://stackoverflow.com/a/1732454) and allows it to be used for cases where the input is totally unknown.
+
+![gopher stading on top of a machine that converts a box of html to blocks of markdown](https://github.com/JohannesKaufmann/html-to-markdown/raw/master/logo.png)
+
+
+# Usage
+
+### $ {{exec "html2md" | color "sh"}}
+
+# Examples
+
+## Simplest form
+
+```md
+$ html2md -i https://github.com/suntong/html2md | head -3
+[Skip to content](#start-of-content)
+
+[Homepage](https://github.com/)
+```
+
+## Using goquery
+
+The most useful feature is to use and pass a [goquery](https://github.com/PuerkitoBio/goquery) selection to filter for the content you want. 
+
+```md
+$ {{.Name}} -i https://github.com/JohannesKaufmann/html-to-markdown -s "div.BorderGrid-row.hide-sm.hide-md > div"
+```
+
+
+## The options and plugins
+
+Works as expected:
+
+```sh
+$ echo '<strong>Bold Text</strong>' | html2md -i
+**Bold Text**
+
+$ echo '<strong>Bold Text</strong>' | html2md -i --opt-strong-delimiter="__"
+__Bold Text__
+
+
+$ echo '<ul><li><input type=checkbox checked>Checked!</li><li><input type=checkbox>Check Me!</li></ul>' | html2md -i -G
+- [x] Checked!
+- [ ] Check Me!
+
+$ echo 'Only <del>blue ones</del> <s> left</s>' | html2md -i --plugin-strikethrough
+Only ~blue ones~ ~left~
+```
+
+# Debian package
+
+Will be available once `github.com/JohannesKaufmann/html-to-markdown` has a release version.
+
+# Install Source
+
+To install the source code instead:
+
+```
+go get github.com/suntong/{{.Name}}
+```
+
+
+## Credits
+
+- [Johannes Kaufmann's html-to-markdown](github.com/JohannesKaufmann/html-to-markdown) that does the heavy lifting behind the scene.
+
+## Similar Projects
+
+- [turndown (js)](https://github.com/domchristie/turndown), a very good library written in javascript.
+- [lunny/html2md](https://github.com/lunny/html2md), which is using [regex instead of goquery](https://stackoverflow.com/a/1732454), which exhibits a few edge cases which prompted `github.com/JohannesKaufmann/html-to-markdown`
+- [jaytaylor/html2text](https://github.com/jaytaylor/html2text), which is not converting to markdown but plain text.
+
+## Author(s) & Contributor(s)
+
+Tong SUN  
+![suntong from cpan.org](https://img.shields.io/badge/suntong-%40cpan.org-lightgrey.svg "suntong from cpan.org")
+
+_Powered by_ [**WireFrame**](https://github.com/go-easygen/wireframe),  [![PoweredBy WireFrame](https://github.com/go-easygen/wireframe/blob/master/PoweredBy-WireFrame-Y.svg)](http://godoc.org/github.com/go-easygen/wireframe), the _one-stop wire-framing solution_ for Go cli based projects, from start to deploy.
+
+All patches welcome.