Skip to content

alexandrabatrak/readme-generator

Repository files navigation

README.md file generator for GitHub repositories.

About

A polished GitHub profile is an important part of your public identity as a developer. Increase your productivity with this node CLI application that uses the inquirer to collect the project information and generates a README.md based on provided information.

Installation

To use this application, fork the repository and clone it to your local environment with:

git clone git@github.com:<your_username>/readme-generator.git

Then install necessary dependencies with:

npm i

Usage

The application can be invoked in the root directory of the application with the following command:

node index.js 

You will then be prompted for all the information about the project.

preview

Full preview video available here

Tools

Credits

Licence

Licenced under the MIT license.

Image of github-profile-views-counter

Copyright © 2023 Alexandra Batrak