Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

github-readme-generator

pH-745MIT1.3.1

Generate easily a README file for your next new project.

readme, generate readme file, github, generate readme, readme template, md generator, readme generator, github readme

readme

GitHub Markdown README Generator

📄 Description

A very simple & quick way to generate outstanding README files for your next GitHub project 🚀

The generated README files are highly optimized for SEO and eye-catching for your readers 🥳

🛠 Installation

If you edit the script on your machine, you will have to run npm link to locally symlink the package, and then run github-readme-generator in your terminal.

🎮 Usage

npx github-readme-generator

GitHub README File Generator

😋 Who cooked it?

Pierre-Henry Soria

@phenrysay pH-7

Pierre-Henry Soria, a highly pragmatic passionate, zen & cool software engineer 😊

⚖️ License

Generously distributed under the MIT