# README When you create a community app, a README.md file will be created, as a template that can be used to standardize the possible [GitHub](https://github.com) repositories. To edit the file you need to know about markdown and how to use it. Check this [guide](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). ## The default file {% tabs %} {% tab title="Preview" %}

{% endtab %} {% tab title="The code" %} {% code title="README.md" overflow="wrap" lineNumbers="true" %} ```markdown

Your App Name - Author Name

Small description of your app.

GitHub all releases

Key Features • How To Use • Download • Credits • License

![screenshot](Images/Screenshot.png) ## Key Features ## How to use ## Download ## Credits ## License ``` {% endcode %} {% endtab %} {% endtabs %} ### Header

<h1 align="center">
  <br>
  <a href="#"><img src="Images/Logo.png" alt="Logo" width="200"></a>
  <br>
  Your App Name - Author Name
  <br>
</h1>

The logo of the readme is taken from the local files of you repository, in the `Images` folder. Below you set the *App Name* and the *Author Name*. ### Description

{% code overflow="wrap" %} ```markdown

Small description of your app.

``` {% endcode %} Put here a small description of your app, but not every little detail, there will be space for that below. ### Badges

<p align="center">
  <a href="https://droptopfour.com/community-apps">
    <img alt="Dynamic version Badge" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2FDroptop-Four%2FGlobalData%2Fmain%2Fdata%2Fcommunity_apps%2Fcommunity_apps.json&query=%24.apps%5B%3F(%40.app.name%20%3D%3D%20'Sample%20App')%5D.app.version&prefix=v&label=Version&color=43ff64">
  </a>
  <a href="https://droptopfour.com"><img src="https://img.shields.io/badge/Droptop%20Four%20Website-43ff64"></a>
  <a href="https://droptopfour.com/discord">
      <img alt="Discord" src="https://img.shields.io/discord/800124057923485728">
  </a>
  <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/Droptop-Four/Sample-Community-App/total">
</p>

The badges are the most difficult and important part of the readme: since they appear immediately to the eye, it's crucial they are set correctly. 1. **Version Badge**: this badge is dynamic, and it syncs automaticaly with the infos of the droptop website. It's important to replace `'Sample%20App'` with the name of the actual app on the website. (Instead of spaces you need to use `%20`) (Example: `My%20Beautiful%20App`) 2. **Website Badge**: static badge for the Droptop website. 3. **Discord Server Badge**: static badge for the Discord server. 4. **Downloads Badge**: this badge is dynamic, and it syncs automatically with the infos of the repo of the app. {% hint style="info" %} If the Downloads Badge errors, it might be because you hit GitHub's rate limits. You can increase Shields.io's rate limit by [adding the Shields GitHub application](https://img.shields.io/github-auth) using your GitHub account. {% endhint %} ### Table of contents

{% code overflow="wrap" lineNumbers="true" %} ```markdown

Key Features • How To Use • Download • Credits • License

``` {% endcode %} You need to add here every header to make users able to navigate to that section faster. You can add, remove and modify the existing ones. ### Screenshot

```markdown ![screenshot](Images/Screenshot.png) ``` You can embed a screenshot of your app, from the local files of you repository, in the `Images` folder. ### Content

{% code overflow="wrap" lineNumbers="true" %} ```markdown ## Key Features ## How to use ## Download ## Credits ## License ``` {% endcode %} Here you'll put every information regarding your app, from features to licenses. If you add, remove, modify the headers, remember to edit the [#table-of-contents](#table-of-contents "mention") too. [^1]: Replace with your app name (ex: `My%20App`) --- # 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.droptopfour.com/community-apps/compile-and-share-the-app/readme.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.