Skip to content

You can easily and quickly create a readme file for your github profile or git hub repository. (visit below) (Click the Get Started button to start the process, Choose Github Readme Template you want, Fill in the desired fields and press the generate button to create your README.md file)

License

Notifications You must be signed in to change notification settings

SashenJayathilaka/Awesome-Github-Readme-Generator

Repository files navigation

logo

Awesome Github Readme Generator

You can easily and quickly create a readme file for your GitHub profile or git hub repository. (visit below) (Click the Get Started button to start the process, Choose Github Readme Template you want, Fill in the desired fields, and press the Generate button to create your README.md file)

contributors last update forks stars open issues license


💻: Support Web Browser

allow
IntelliJ IDEA
Edge Firefox Chrome Opera Brave Safari

📔 Table of Contents

🌟 About the Project

📷 Screenshots

  • Github Readme File Generator GetStarted
screenshot

  • Fill in the desired fields
screenshot

  • Fill in the desired fields and press the generate button to create your README.md file (& new release)
screenshot

forthebadge forthebadge forthebadge

🎯 Features

  • Github Profile README.md Generator
  • Github Repository README.md Generator

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

GITHUB_ID

GITHUB_SECRET

GOOGLE_CLIENT_ID

GOOGLE_CLIENT_SECRET

NEXT_PUBLIC_SECRET

NEXT_PUBLIC_SKILL_API_KEY

🧰 Getting Started

🏃 Run Locally

Clone the project

  git clone https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git

Go to the project directory

  cd Github-Readme-File-Generator

Install dependencies

  npm install

Start the server

  npm run start

🧭 Roadmap

  • Github Profile README.md Generator
  • Github Repository README.md Generator

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

📜 Code of Conduct

Please read the Code of Conduct

💻 Built with

🙇 Special Thanks

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

My Name - Sashen Jayathilaka - sashenjayathilaka95@gmail.com

Project Link: https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git

About

You can easily and quickly create a readme file for your github profile or git hub repository. (visit below) (Click the Get Started button to start the process, Choose Github Readme Template you want, Fill in the desired fields and press the generate button to create your README.md file)

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages