README

How to use the default 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 repositories.

To edit the file you need to know about markdown and how to use it. Check this guide.

The default file

Preview

Preview of the README

The code

README.md

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

<h4 align="center">Small description of your app.</h4>

<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>

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#how-to-use">How To Use</a> •
  <a href="#download">Download</a> •
  <a href="#credits">Credits</a> •
  <a href="#license">License</a>
</p>

![screenshot](Images/Screenshot.png)

## Key Features

## How to use

## Download

## Credits

## License

Header

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

Description

<h4 align="center">Small description of your app.</h4>

Put here a small description of your app, but not every little detail, there will be space for that below.

Badges

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'')%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.

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 using your GitHub account.

Table of contents

Table of Contents

<p align="center">
  <a href="#key-features">Key Features</a> •
  <a href="#how-to-use">How To Use</a> •
  <a href="#download">Download</a> •
  <a href="#credits">Credits</a> •
  <a href="#license">License</a>
</p>

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

Screenshot

![screenshot](Images/Screenshot.png)

You can embed a screenshot of your app, from the local files of you repository, in the Images folder.

Content

Content

## Key Features

## How to use

## Download

## Credits

## License

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 too.