gtalarico
diff --git a/‎README.md
Lines changed: 46 additions & 19 deletions b/‎README.md
Lines changed: 46 additions & 19 deletions
@@ -1,6 +1,4 @@
-# TODO: Add important files table from Django Readme
-
-# Flask-VueJs-Template
+# Flask-VueJs-Template 🌶️✌
 
 [![Build Status](https://travis-ci.org/gtalarico/flask-vuejs-template.svg?branch=master)](https://travis-ci.org/gtalarico/flask-vuejs-template)
 [![codecov](https://codecov.io/gh/gtalarico/flask-vuejs-template/branch/master/graph/badge.svg)](https://codecov.io/gh/gtalarico/flask-vuejs-template)
@@ -9,19 +7,28 @@ _Flask + Vue.js Web Application Template_
 
 ![Vue Logo](/docs/vue-logo.png "Vue Logo") ![Flask Logo](/docs/flask-logo.png "Flask Logo")
 
-[Live Demo](https://flask-vuejs-template.herokuapp.com/#/api)
-
 ## Features
 * Minimal Flask 1.0 App
 * [Flask-RestPlus](http://flask-restplus.readthedocs.io) API with class-based secure resource routing
 * Starter [PyTest](http://pytest.org) test suite
-* [vue-cli 3](https://github.com/vuejs/vue-cli/blob/dev/docs/README.md)
+* [vue-cli 3](https://github.com/vuejs/vue-cli/blob/dev/docs/README.md) + yarn
 * [Vuex](https://vuex.vuejs.org/)
 * [Vue Router](https://router.vuejs.org/)
 * [Axios](https://vuex.vuejs.org/) for backend communication
 * Sample Vue [Filters](https://vuejs.org/v2/guide/filters.html)
 * Heroku Configuration with one-click deployment + Gunicorn
 
+#### Alternatives
+If this setup is not what you are looking for, you might want look at other similar projects:
+
+* [oleg-agapov/flask-vue-spa](https://github.com/oleg-agapov/flask-vue-spa)
+* [testdrivenio/flask-vue-crud](https://github.com/testdrivenio/flask-vue-crud)
+
+Prefer Django? Checkout my [gtalarico/django-vue-template](https://github.com/gtalarico/django-vue-template)
+
+## Demo
+[Live Demo](https://flask-vuejs-template.herokuapp.com/#/api)
+
 ## Template Structure
 
 The template uses Flask & Flask-RestPlus to create a minimal REST style API,
@@ -43,11 +50,25 @@ files as generated by vue cli + webpack
 
 The Vue instance is preconfigured with Filters, Vue-Router, Vuex; each of these can easilly removed if they are not desired.
 
+#### Important Files
+
+| Location             |  Content                                   |
+|----------------------|--------------------------------------------|
+| `/app`               | Flask Application                          |
+| `/app/api`           | Flask Rest Api (`/api`)                    |
+| `/app/client.py`     | Flask Client (`/`)                         |
+| `/src`               | Vue App .                                  |
+| `/src/main.js`       | JS Application Entry Point                 |
+| `/public/index.html` | Html Application Entry Point (`/`)         |
+| `/public/static`     | Static Assets                              |
+| `/dist/`             | Bundled Assets Output (generated at `yarn build` |
+
+
 ## Installation
 
 ##### Before you start
 
-Before getting started you should have the following installed and running:
+Before getting started, you should have the following installed and running:
 
 - [X] Yarn - [instructions](https://yarnpkg.com/en/docs/install#mac-stable)
 - [X] Vue Cli 3 - [instructions](https://cli.vuejs.org/guide/installation.html)
@@ -94,8 +115,9 @@ $ yarn serve
 The Vuejs application will be served from `localhost:8080` and the Flask Api
 and static files will be served from `localhost:5000`.
 
-The dual dev server setup allows you to take advantage of
+The dual dev-server setup allows you to take advantage of
 webpack's development server with hot module replacement.
+
 Proxy config in `vue.config.js` is used to route the requests
 back to Flask's Api on port 5000.
 
@@ -114,30 +136,35 @@ $ python run.py
 This template is configured to work with Heroku + Gunicorn and it's pre-configured
 to have Heroku build the application before releasing it.
 
+#### JS Build Process
+
+Heroku's nodejs buidlpack will handle install for all the dependencies from the `packages.json` file.
+It will then trigger the `postinstall` command which calls `yarn build`.
+This will create the bundled `dist` folder which will be served by whitenoise.
+
+#### Python Build Process
+
+The python buildpack will detect the `Pipfile` and install all the python dependencies.
+
+#### Release
+
+The `Procfile` will run Django migrations and then launch Django's app using gunicorn, as recommended by heroku.
+
+#### Production Sever Setup
+
 Here are the commands we need to run to get things setup on the Heroku side:
 
 	```
 	$ heroku apps:create flask-vuejs-template-demo
 	$ heroku git:remote --app flask-vuejs-template-demo
 	$ heroku buildpacks:add --index 1 heroku/nodejs
 	$ heroku buildpacks:add --index 2 heroku/python
-	$ heroku addons:create heroku-postgresql:hobby-dev
 	$ heroku config:set FLASK_ENV=production
 	$ heroku config:set FLASK_SECRET=SuperSecretKey
 
 	$ git push heroku
 	```
 
-Heroku's nodejs buidlpack will handle install for all the dependencies from the `packages.json` file.
-It will then trigger the `postinstall` command which calls `yarn build`.
-This will create the bundled `dist` folder which will be served by whitenoise.
-
-The python buildpack will detect the `pipfile` and install all the python dependencies.
-
-The `Procfile` will run Django migrations and then launch Django'S app using gunicorn, as recommended by heroku.
-
 ### Heroku deployment - One Click Deploy
 
-You can spin up your on version of this template on Heroku:
-
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/gtalarico/flask-vuejs-template)