- All elements centered
- Project title
- GitHub's SEO examines the project's name, description, topics, stars, watchers, and forks via traffic, the README, and file types
- Logo or banner
- Usually created with Canva. However, I am looking for a more libre-friendly alternative; please let me know if you are aware of one.
- Description
- Include your core keywords and not much else. Add an emoji to the end of the description.
- Badges
- Create new or use pre-existing badges
- Unsupported gradient badges
- 4 badges
- Programming language
- License
- Tech (ex: Docker)
- Sponsor button
- Create new or use pre-existing badges
<!-- Centers elements-->
<div align="center">
<!--Project title-->
# Project-title
<!-- Light mode logo -->
<img src="light-mode-logo.png" alt="Light mode logo" class="logo">
<!-- Dark mode logo -->
<img src="dark-mode-logo.png" alt="Dark mode logo" class="logo">
<!-- -->
<!--Description + emoji -->
Description
<!--Badges-->
<a href=" your_link "></a>
<a href=" your_link "></a>
<a href=" your_link "></a>
<a href="https://github.com/sponsors/oliviagallucci"></a>
</div>
<!--
Below, I am displaying two different images with the same class name .logo but with different src attributes. Then, I use CSS media queries to hide the logo that's not appropriate for the user's current color scheme.
-->
<style>
@media (prefers-color-scheme: dark) {
/* Hide light mode logo in dark mode */
.logo[src="light-mode-logo.png"] {
display: none;
}
}
@media (prefers-color-scheme: light) {
/* Hide dark mode logo in light mode */
.logo[src="dark-mode-logo.png"] {
display: none;
}
}
</style>
Create a GIF demo via Peek showing how the project is used. Credits to Peek for the GIF above.
- Create custom Terminal GIFs
Usage steps
Be concise. People have incredibly short attention spans. Cut all the excess wording out of your README.
- Use semantic versioning
- Versions are separated into major, minor, patch and pre-release. The identifiers below from left to right: major, minor, and patch versions are always compared numerically.
- Example: 1.0.0 < 2.0.0 < 2.1.0 < 2.1.1.
- Versions are separated into major, minor, patch and pre-release. The identifiers below from left to right: major, minor, and patch versions are always compared numerically.
- Pre-release examples
- 1.0.0-alpha
- testing is done by developers only
- 1.0.0-beta
- testing is done by users and developers
- 1.0.0-alpha
- Olivia Gallucci (@oliviagallucci) - https://oliviagallucci.com
- List of contributors who participated in this project.
- Supporters (do something with this)
The author of this tool offers no warranty or guarantee for its performance, reliability, or suitability for any particular purpose.
The tool is provided "as is" without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.
Use of this tool is entirely at the user's own risk. The author does not accept any liability for any loss, damage or expense incurred by the user or any third party resulting from the use of this tool, whether direct or indirect.
Furthermore, the author expressly disclaims any responsibility or liability for the accuracy, content, or availability of information found through the use of this tool, or for any harm caused by viruses, malware, or other harmful components that may be introduced into your system as a result of using this tool.
By using this tool, the user acknowledges that they have read this warranty statement and agree to assume all risks associated with its use.
The creator(s) of this tool provides no warranty or assurance regarding its performance, dependability, or suitability for any specific purpose.
The tool is furnished on an "as is" basis without any form of warranty, whether express or implied, encompassing, but not limited to, implied warranties of merchantability, fitness for a particular purpose, or non-infringement.
The user assumes full responsibility for employing this tool and does so at their own peril. The creator(s) holds no accountability for any loss, damage, or expenses sustained by the user or any third party due to the utilization of this tool, whether in a direct or indirect manner.
Moreover, the creator(s) explicitly renounces any liability or responsibility for the accuracy, substance, or availability of information acquired through the use of this tool, as well as for any harm inflicted by viruses, malware, or other malicious components that may infiltrate the user's system as a result of employing this tool.
By utilizing this tool, the user acknowledges that they have perused and understood this warranty declaration and agree to undertake all risks linked to its utilization.
This project is licensed under the General Public License version 3.0 - see the LICENSE.md file for details
Markdown is a lightweight markup language that is used to format plain text documents. It was created to be easy to write and read in plain text, while also allowing for the conversion of the text into HTML or other document formats.
Markdown is often used for creating documents, web pages, README files, and other types of content that require basic formatting.
In Markdown, formatting is achieved through the use of simple and intuitive syntax, such as:
# Top-level heading
## Second-level heading
### Third-level heading (and so on)
*italic text* or _italic text_
**bold text** or __bold text__
1. First item
2. Second item
- Bulleted item 1
- Bulleted item 2
[Olivia's website](https://oliviagallucci.com)
`inline code`
> This is a blockquote.
<p align="center">
<a href="https://github.com/username/your_project#">
<img src="https://github.com/oliviagallucci/README/blob/main/images/backToTopButtonTransparentBackground.png" alt="Back to top" height="29"/>
</a>
</p>