README Files

Code

# repository-name
[![CircleCI](https://img.shields.io/circleci/project/byuoitav/repository-name.svg)](https://circleci.com/gh/byuoitav/repository-name) [![Apache 2 License](https://img.shields.io/hexpm/l/plug.svg)](https://raw.githubusercontent.com/byuoitav/repository-name/master/LICENSE)

Utilize the following as the top of your repository's README.md file. Be sure to replace "repository-name" with the actual name of your repository in the above snippet.

Borrowing from the avengineers-slackbot, the above code results in the following header:

avengineers-slackbot

Swagger Documents

If your project has an accompanying Swagger Document, link to it in your README file (directly underneath the header defined above) by utilizing jessemillar's view-in-swagger-button project.

Since our team runs a custom instance of the swagger-ui project, we utilize a slightly different code snippet than the one linked in the view-in-swagger-button README. Our snippet is defined below. Be sure to replace ... with the direct URL to your GitHub-hosted swagger.json document.

[![View in Swagger](http://jessemillar.github.io/view-in-swagger-button/button.svg)](http://byuoitav.github.io/swagger-ui/?url=...)