Skip to content

README file generator for crafting professional README files on GitHub.

Notifications You must be signed in to change notification settings

tigerkaplan/readme_generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

readme_generator

Github license

Description

The readme.md file generator is a user friendy duide to generate easily peofessional documents fr GitHub. The project has clear instructions for setup, usage, contributionsand other required and optional sections for a professional lookimg readme file. It isdesigned to ensure everyone can easily understand and using project functionalities.

Table of Contents

Deployment

To deploy this project run npm run deploy

Demo

https://www.youtube.com/watch?v=uUla1IiF3gM

Screenshot

Output of the project in gif format

ReadMe.js

Output of the project in image format


index.js_generateMarkDown.js

Languages

Javascript, NodeJs

Usage

This project can be used The project allows that to create a readme.md file as professionally as well as not spending long time for projects.

Installation

Install readme_generator with this project locally, firstly clone the repository to your local machine and install npm npm install

Contributors

Contributions are always welcome!

Tests

npm run test

Author

@tigerkaplan

Repository

https://github.com/tigerkaplan/readme_generator

Questions

Please send your questions here or visit github/tigerkaplan for my other projects on GitHub.

About

README file generator for crafting professional README files on GitHub.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published