/github-readme-generator-cli

📄 A PHP README File Generator, to generate easily beautiful (and SEO-friendly) GitHub README files on the fly 🎉

Primary LanguagePHPMIT LicenseMIT

README Generator 🚀

Simplest way to generate SEO-optimized GitHub README

📄 PHP README File Generator, to generate easily beautiful (and SEO-friendly) GitHub README files on the fly 🚀

  • NEW v1.2.0: Default values are pre-selected from the information already present in the composer.json file.

    github-readme-generator reads composer.json info and suggest the default values during the creation of your README.md file ✨

  1. Requirement
  2. Setup
  3. Me Coding It
  4. About Me
  5. License

📙 Requirement

  • Make sure you have PHP 8.0 or a higher version installed.

⚙️ Setup

  • Install Composer v2 or higher (https://getcomposer.org)

  • Install the dependencies with composer as below

    composer install

  • Update the permissions of the generate bash file located in the root directory

    chmod u+x ./generate

  • Run the script, and follow the instruction shown. Enjoy 😺

    ./generate

GitHub README File Generator CLI

📺 Video

Watch the video

👉 Click here to watch on YouTube

🤠 About Me

Pierre-Henry Soria

@phenrysay pH-7

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

You can keep in touch with me at: hi [AT] pH7 {D0T} me 📮

⚖️ License

This PHP README Generator CLI script is generously distributed under the MIT.