# 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](https://guides.github.com/features/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. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.polarity.io/integrations/build-an-integration/readme-guide.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.