othneildrew /Best-README-Template
An awesome README template to jumpstart your projects!
★ 16,466⑂ 22,907👁 70⑃ 115● 56▤ 2
+1
Daily
16,466
stars
22,907
forks
70
watchers
115
prs
56
issues
2
releases
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Unlicense License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Best-README-Template
An awesome README template to jumpstart your projects!
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Built With
Getting Started
Prerequisites
Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments
About The Project
[![Product Name Screen Shot][product-screenshot]](https://example.com)
There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.
Here's why:
Your time should be focused on creating something amazing. A project that solves a problem and helps others
You shouldn't be doing the same tasks over and over like creating a README from scratch
You should implement DRY principles to the rest of your life :smile:
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people who have contributed to expanding this template!
Use the BLANK_README.md to get started.
(back to top)
Built With
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
[![Next][Next.js]][Next-url]
[![React][React.js]][React-url]
[![Vue][Vue.js]][Vue-url]
[![Angular][Angular.io]][Angular-url]
[![Svelte][Svelte.dev]][Svelte-url]
[![Laravel][Laravel.com]][Laravel-url]
[![Bootstrap][Bootstrap.com]][Bootstrap-url]
[![JQuery][JQuery.com]][JQuery-url]
(back to top)
Getting Started
This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.
Prerequisites
This is an example of how to list things you need to use the software and how to install them.
npm
sh
npm install npm@latest -g
Installation
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
1. Get a free API Key at https://example.com
2. Clone the repo
sh
git clone https://github.com/github_username/repo_name.git
3. Install NPM packages
sh
npm install
4. Enter your API in config.js
js
const API_Top issues
#177The URL of the logo is wrong4 comments · 2026-07-11#180theres nothing in the game1 comments · 2026-08-25#158Suggestion: [Feature] Add customizable “Back to Top” links and multi-language support in README template1 comments · 2025-08-24#182Link to emoji cheatsheet not working0 comments · 2026-10-13
Discussions
#169Feature: Minor Improvement for Referenced Files0 comments · 2026-03-12#160Project Direction & Contribution Guidelines1 comments · 2025-09-23#159Frequently Asked Questions (FAQs)0 comments · 2025-09-23
Latest release
v1.1.2 v1.1.2 2024-12-07What's Changed Update LICENSE.txt, change to Unlicense by @othneildrew in https://github.com/othneildrew/Best-README-Template/pull/138 Update project cover image and add "project_license" to search and replace keywords Full Changelog: https://github.com/othneildrew/Best-README-Template/compare/v1.1.1...v1.1.2