diff --git a/README b/README deleted file mode 100644 index 270a849..0000000 --- a/README +++ /dev/null @@ -1,12 +0,0 @@ -Flask Debug-toolbar - -A port of the django-debug toolbar (github.com/robhudson/django-debug-toolbar) -to Flask. - -Usage:: - - from flask import Flask - from flask_debugtoolbar import DebugToolbarExtension - - app = Flask(__name__) - toolbar = DebugToolbarExtension(app) diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..ec363ad --- /dev/null +++ b/README.rst @@ -0,0 +1,30 @@ +Flask Debug-toolbar +=================== + +This is a port of the excellent `django-debug-toolbar `_ +for Flask applications. + +Usage +----- + +Installing the debug toolbar is simple:: + + from flask import Flask + from flask_debugtoolbar import DebugToolbarExtension + + app = Flask(__name__) + toolbar = DebugToolbarExtension(app) + + +The toolbar will automatically be injected into Jinja templates when debug mode is on:: + + app.debug = True + + +Installation +------------ + +Installing is simple with pip:: + + $ pip install flask-debugtoolbar +