diff --git a/README.md b/README.md index 3f245ed..5375e2e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,18 @@ -flask-tumblelog -=============== +A Flask Tumblelog +================= -A mongoengine flask tumblelog \ No newline at end of file +The source code for the [Write a Tumblelog Application with Flask and MongoEngine](http://docs.mongodb.org/manual/tutorial/write-a-tumblelog-application-with-flask-mongoengine/) +tutorial. + +Installation +------------ + + 1. Install [pip](http://www.pip-installer.org/en/latest/installing.html) + 2. Make a [virtualenv](http://virtualenvwrapper.readthedocs.org/en/latest/#introduction) for this project + 3. Install the required dependencies: `pip install -r requirements.txt` + +Run the tumblelog: + + python manage.py runserver + +Goto: [http://localhost:5000](http://localhost:5000) \ No newline at end of file