diff --git a/README.rst b/README.rst index e69de29..ae93379 100644 --- a/README.rst +++ b/README.rst @@ -0,0 +1,29 @@ +Installation +============ + +``pip install markdownify`` + + +Usage +===== + +Convert some HTML to Markdown: + +.. code:: python + + from markdownify import markdownify as md + md('Yay GitHub') # > '**Yay** [GitHub](http://github.com)' + +Specify tags to exclude (blacklist): + +.. code:: python + + from markdownify import markdownify as md + md('Yay GitHub', strip=['a']) # > '**Yay** GitHub' + +\...or specify the tags you want to include (whitelist): + +.. code:: python + + from markdownify import markdownify as md + md('Yay GitHub', convert=['b']) # > '**Yay** GitHub'