ReadMe Generator

Introduction

Welcome to the ReadMe generator! This project is designed to simplify the generation of readme in an easier way.

Description

This app is developed in ReactJS, and it's main focus is to generate a good readme without the knowledge of markdown only. It updates dynamically the input value and converts it into markdown language. In the future, many more features will be added, like the addition of required options and licenses, and many more.

Images

Output 1: Output 2: Output 3: Output 4:

Features

1. Dynamic
2. Easy Conversion into Markdown
3. Fast
4. Easy to operate

Installation

git clone https://github.com/kareem1207/Read-Me-generator.git
npm create vite@latest Read-me-generator
cd Read-me-generator

replace vite src with cloned src files

Usage

Used to develop a good Github Readme easily and quickly.

Contributing Guidelines

If you want to contribute to this project, then fork the project and then follow the installation steps.

Tech Stacks

• React JS

Note

this readme is generated using this code only

Tip

https://readme-generator-github.netlify.app/ it the deployed version of this code

Important

Fork Before Using

Warning

Use it carefully

Caution

Don't change anything unless you're sure about what you're doing.