Merge pull request #3 from kennethreitz/readme

Updated Readme
This commit is contained in:
Matt Good
2012-01-30 17:50:38 -08:00
2 changed files with 30 additions and 12 deletions

12
README
View File

@@ -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)

30
README.rst Normal file
View File

@@ -0,0 +1,30 @@
Flask Debug-toolbar
===================
This is a port of the excellent `django-debug-toolbar <github.com/robhudson/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