Readme-Icons

Currated by @Andre601

Welcome to the Readme-Icons Repository!
This Repository aims to provide various SVG icons and images to use in your Readme, or any other markdown file.

The icons are in 16x16 scale perfect for normal text sizes of GitHub.

Table of Contents

• How to use
  • Specific versions
• Licenses
• Why use this and not the actual source?
• Icons
  • Gifs
  • Octicons
• Submit Icons

How to use

We keep all our icons/images in a icon directory, where they are further split up into categories.

The easiest way to use the icons is to use JSDelivr for it.
Simply visit https://cdn.jsdelivr.net/gh/Readme-Workflows/Readme-Icons@main/icons/ open the respective folder, click on the name of the Icon you want to use and copy your current URL from your browser.

This link can then be used through Markdown's image-link format (![text](:link)) or through the reference link-syntax ([text]: :link) to then use in multiple places with ![text]

Specific versions

Thanks to releases can you also use specific versions for your icons.
This is useful if your icon got changed or even removed but you still want to use it.

To use specific versions, replace main in Readme-Icons@main with the version you would like to use (i.e. Readme-Icons@v1.0.0).
Keep in mind that there needs to be a valid Release on this Repository for this to work!

Version Policy

We have a Version Policy to explain how we update the latest version.

Licenses

Please note that the different icons may have different licenses. Each folder in the icons directory is equipped with a copy of the respective license(s) used.

Why use this and not the actual source?

There are multiple reasons to use this over the existing sources:

1. Recoloured SVGs
   There is no easy way to recolour existing SVG icons without manipulating their <svg> or <path> tags, especially with markdown-syntaxes.
   Here, the icons have receieved new colours where needed to represent their common use place. This allows you to have coloured SVG icons without much work.
2. Single Source
   Thanks to this Repository will you only have a single source you need to use compared to other places. This reduces the need of maintainability a lot as you don't have to worry about the source suddenly changing or even being gone.
3. Safe
   Using this Repository over the source is much more save, as we won't remove existing SVG icons without any prior notice.
   Each Icon change or removal is done through Pull request and mentioned in any possible release on this Repository.

If you have any further questions or just want to get in touch with us, join our Discord Server.

Icons

The icons are split up into different categories.
Each category has their own README file with the icons listed.

Gifs

Collection of 16x16 gifs you can use in your README.

To the page

Octicons

GitHub's own Set of SVG icons.

To the page

Submit Icons

Do you want to add some icons to this Repository?
If yes, make sure to follow the basic guidelines in our Contributing file.