aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2014-11-15 00:40:56 -0500
committerTeddy Wing2014-11-15 00:40:56 -0500
commit060abc3b697d50ed8b534b9f2a22351398047494 (patch)
tree05fb819e930449fc6ed7d760d7a046c0d28faa5d
parent823ffe91d8f24d81ca2ad853488ea4c11d058c04 (diff)
downloadunXHTMLify-060abc3b697d50ed8b534b9f2a22351398047494.tar.bz2
README: Update with instructions on installing & runningHEADmaster
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2e263ec..5b6fdbd 100644
--- a/README.md
+++ b/README.md
@@ -14,5 +14,18 @@ Currently the implementation is very simplistic and liberal. Any `/>` will get r
Takes input from STDIN and outputs to STDOUT.
+## Installing
+
+ $ go get github.com/teddywing/unXHTMLify
+ $ cd $GOPATH/src/github.com/teddywing/unXHTMLify
+ $ go install
+
+
+## Running
+Pipe an HTML file into `unXHTMLify` to convert the file:
+
+ $ cat sample.html | unXHTMLify > sample-converted.html
+
+
## License
Licensed under the MIT license. See the included LICENSE file.