summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md41
1 files changed, 31 insertions, 10 deletions
diff --git a/README.md b/README.md
index a43d897..416877f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,34 @@
-Heroky Python Skeleton
-======================
+# Heroky Python Skeleton
-This repository has all the base files ready for deploying a Heroku application.
+This repository has all the base files ready for deploying a Heroku application, including a simple database model managed with flask-sqlalchemy.
-Usage
------
+## Usage
- - `git clone https://github.com/yuvadm/heroku-python-skeleton.git`
- - `cd heroku-python-skeleton`
- - `heroku create`
- - `heroku addons:add heroku-postgresql:dev`
- - `git push heroku master`
+### Initial
+
+```bash
+$ git clone https://github.com/yuvadm/heroku-python-skeleton.git
+$ cd heroku-python-skeleton
+$ heroku create
+$ git push heroku master
+```
+
+### Database
+
+```bash
+$ heroku addons:add heroku-postgresql:dev
+-----> Adding heroku-postgresql:dev to some-app-name... done, v196 (free)
+Attached as HEROKU_POSTGRESQL_COLOR
+Database has been created and is available
+$ heroku pg:promote HEROKU_POSTGRESQL_COLOR
+$ heroku run python
+```
+
+and in the Python REPL:
+
+```python
+>>> from app import db
+>>> db.create_all()
+```
+
+For a detailed introduction see [http://blog.y3xz.com/blog/2012/08/16/flask-and-postgresql-on-heroku/](http://blog.y3xz.com/blog/2012/08/16/flask-and-postgresql-on-heroku/).