README Guide

Directory Location

sample-integration/
└── README.md

Summary

The README.md file is a markdown file that provides a detailed overview of the integration. The README.md file should be written using GitHub flavored markdown. You can learn more about markdown syntax by reading the "Mastering Markdown" guide on GitHub.

Suggested Information

We recommend providing the following information in your README.md file.

Author

Who developed the integration?

Overview

A brief overview of what the integration does. What data does it connect to and what does it display? What are the requirements for using the integration? Including a screenshot of the Overlay Window is a great way to provide a quick sense of the information displayed.

User Options

What options does the integration expose to the end user? Which options should be admin only and which are per user?

Developer Notes

Any notes for developers looking to fork or submit pull requests for your integration.