Example README.md

Intro to the repository goes here.

Table of content (optional)

• Installation
  • Pre-built binaries
  • Installing from source
• Usage
• Documentation
• Issues
• Contributing
• License

Installation

Pre-built binaries

Short version for downloading and installing binaries when available.

Installing from source

Prerequisites

What is required to install the software from the source.

Building and installing

Instructions for building and installing the softeware from the source.

go get github.com/...
cd $GOPATH/src/github.com/...
etc...

Usage

Instructions on how to get started with the software once installed.

Sample templates, example commands, etc...

something something run

Examples of outputs that can be expected.

$ example command

==> Builds finished. The artifacts of successful builds are:
--> Private template (UUID: 01875f67-4eb5-4d90-982c-d7a164646fcb, Title: packer-builder-1468327456-disk1-template-1468327515)

Documentation

Expanding on available documentation

Issues (optional)

What to do if you spot a bug? Open a new issue here.

Contributing (optional)

How to contribute to the software. Forking and pull requests.

License

This project is distributed under the MIT License, see LICENSE.txt for more information.