From 49b1c1ee288b50c825285df3ce39c28bd366fe20 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Thu, 26 Sep 2013 20:36:23 -0400 Subject: [PATCH] readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f808730 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# url2markdown + +This is a very simple web service that will take a given URL, and return +a Markdown representation of that page. + +Powered by [Readability](http://readability.com/), [Requests](http://python-guide.org/), [html2text](http://www.aaronsw.com/2002/html2text/) and [Flask](http://flask.pocoo.org/). + +## Usage + + + $ curl http://url2markdown.herokuapp.com/url=http://kennethreitz. + + My name is Kenneth Reitz. + + I am a wandering street photographer, musician, and moral fallibilist. + + I'm the product owner of Python at Heroku and a member of the Python Software + Foundation. I believe that simplicity is always better than functionality. + ... + +Enjoy! + +## Configuration + +This application requires a [Readability Parser Token](http://www.readability.com/developers/api/parser). + + $ export READABILITY_TOKEN=xxxxxx + +You can use [autoenv](https://github.com/kennethreitz/autoenv) to do this easily. \ No newline at end of file