Standard Readme for all new Examples

SampleReadme.md

The Title of the app

Description of the app/example and what it should do. This is a first draft on increasing the quality/readability of or examples.

Keep in mind when creating the README that:

• This is a developers first/second interaction with the app platform. We want the developer to come away with a sense of accomplishment NOT frustration/confusion.
• This is PUBLIC code that Bandwidth.com is sponsoring! (Think of it as an endorsement)
• The more handholding through the README the better. Having too much information is better than not enough.

This is where we should introduce the technologies used in this app.

• Nodejs
• Grunt
• node-bandwidth SDK
• Use Markdown

The flow of the app (Again more details the better!)

Walk the reader through the primary catapult flow, try to include a link to resource you're using.

This app will:

• Order a TN
• Create an application
• Create a SIP Domain
• Create a SIP Endpoint
• Handle phone calls

Prerequisites

Talk about any prereqs the user should meet before trying to install/use the app.

Use bullet point list that:

• Include what the prereq is
• And where to get the prereq

Install / Configuration

Walk the reader through how to install/setup the app. Include screen shots if possible.

Bullet point list

• Work better
• Are easier to read
• Look professional
• Look at Bandcast.io for an example

Deploy Locally

Walk the user through setting:

• Environment variables
• Which port application defaults to
• Mention Ngrok

Deploy Heroku or Azure

Manual steps to deploy if they don't want the button

More information

Any more information that could be relevant to the user