https://github.com/ph-7/cool-readme-generator

🦩 The way I generate easily my README file for my projects 📄 An efficient & elegant generator for creating beautiful and SEO-optimized `readme.md` files.
https://github.com/ph-7/cool-readme-generator

generator github github-readme github-readme-generator markdown md-template node npm readme readme-generator readme-markdown-generator readme-template

Last synced: 24 days ago
JSON representation

🦩 The way I generate easily my README file for my projects 📄 An efficient & elegant generator for creating beautiful and SEO-optimized `readme.md` files.

• Host: GitHub
• URL: https://github.com/ph-7/cool-readme-generator
• Owner: pH-7
• License: mit
• Created: 2021-09-25T12:58:18.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-06T09:54:58.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T22:20:36.459Z (24 days ago)
• Topics: generator, github, github-readme, github-readme-generator, markdown, md-template, node, npm, readme, readme-generator, readme-markdown-generator, readme-template
• Language: JavaScript
• Homepage: https://npmjs.com/package/github-readme-generator
• Size: 949 KB
• Stars: 10
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

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

```bash

npx github-readme-generator

```

![GitHub README File Generator](github-readme-generator-usage.png)

## :tv: Video

[![Watch the video](https://i1.ytimg.com/vi/knK7JMwxl3M/sddefault.jpg)](https://www.youtube.com/watch?v=knK7JMwxl3M)

👉 **[Click here to watch on YouTube](https://www.youtube.com/watch?v=knK7JMwxl3M)** 🎉

## 😋 Who cooked it?

[![Pierre-Henry Soria](https://avatars0.githubusercontent.com/u/1325411?s=200)](https://ph7.me 'My personal website :-)')

[![@phenrysay][twitter-image]](https://twitter.com/phenrysay) [![pH-7][github-image]](https://github.com/pH-7)

**[Pierre-Henry Soria](https://ph7.me)**, a highly pragmatic passionate, zen & cool software engineer 😊

## ⚖️ License

Generously distributed under the _[MIT](https://opensource.org/licenses/MIT)_

[twitter-image]: https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white

[github-image]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white