diff --git a/README.md b/README.md
index afcf162..54d9a52 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,30 @@
-# Introduction
+
+MLH Hackathon Flask Starter
+
+
+
+
+
+
+
+
+## Table of Contents
+
+
+Click to expand
+
+1. [Introduction](#1-introduction)
+2. [Installation Guide](#2-installation-guide)
+3. [What's Included?](#3-whats-included)
+4. [Code of Conduct](#4-code-of-conduct)
+5. [License](#5-license)
+
+
+
+
+## 1 Introduction
This is a hackathon boilerplate for new Flask web applications created by [Major League Hacking](https://github.com/MLH). It is for hackers looking to get started quickly on a new hackathon project using the Flask microframework.
@@ -6,7 +32,7 @@ This is a hackathon boilerplate for new Flask web applications created by [Major
- [User Guide](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/docs/USER_GUIDE.md) - How to develop apps created with this starter project
- [Contributing Guide](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/docs/CONTRIBUTING.md) - How to contribute to the project
-# Installation Guide
+## 2 Installation Guide
This project requires the following tools:
@@ -16,11 +42,11 @@ This project requires the following tools:
To get started, install Python and Postgres on your local computer if you don't have them already. A simple way for Mac OS X users to install Postgres is using [Postgres.app](https://postgresapp.com/). You can optionally use another database system instead of Postgres, like [SQLite](http://flask.pocoo.org/docs/1.0/patterns/sqlite3/).
-## Getting Started
+### Getting Started
**Step 1. Clone the code into a fresh folder**
-```
+```bash
$ git clone https://github.com/MLH/mlh-hackathon-flask-starter.git
$ cd mlh-hackathon-flask-starter
```
@@ -29,14 +55,14 @@ $ cd mlh-hackathon-flask-starter
Create a new Virtual Environment for the project and activate it. If you don't have the `virtualenv` command yet, you can find installation [instructions here](https://virtualenv.readthedocs.io/en/latest/). Learn more about [Virtual Environments](http://flask.pocoo.org/docs/1.0/installation/#virtual-environments).
-```
+```bash
$ virtualenv venv
$ source venv/bin/activate
```
Next, we need to install the project dependencies, which are listed in `requirements.txt`.
-```
+```bash
(venv) $ pip install -r requirements.txt
```
@@ -75,7 +101,7 @@ You replace the GitHub credentials here and update the database URL. Learn more
Now we're ready to start our server which is as simple as:
-```
+```bash
(venv) $ flask run
```
@@ -84,7 +110,7 @@ Open http://localhost:5000 to view it in your browser.
The app will automatically reload if you make changes to the code.
You will see the build errors and warnings in the console.
-# What's Included?
+## 3 What's Included?
- [Flask](http://flask.pocoo.org/) - A microframework for Python web applications
- [Flask Blueprints](http://flask.pocoo.org/docs/1.0/blueprints/) - A Flask extension for making modular applications
@@ -93,10 +119,14 @@ You will see the build errors and warnings in the console.
- [Bootstrap 4](https://getbootstrap.com/) - An open source design system for HTML, CSS, and JS.
- [Jinja2](http://jinja.pocoo.org/docs/2.10/) - A templating language for Python, used by Flask.
-# Code of Conduct
+## 4 Code of Conduct
We enforce a Code of Conduct for all maintainers and contributors of this Guide. Read more in [CONDUCT.md](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/docs/CONDUCT.md).
-# License
+## 5 License
The Hackathon Starter Kit is open source software [licensed as MIT](https://github.com/MLH/mlh-hackathon-flask-starter/blob/master/LICENSE.md).
+
+
+🌟 PLEASE STAR THIS REPO IF YOU FOUND SOMETHING INTERESTING 🌟
+
\ No newline at end of file