https://github.com/blindsweatyhansolo/readmepro
CLI App for generating a professional looking README file for your next project.
https://github.com/blindsweatyhansolo/readmepro
inquirer javascript markdown nodejs
Last synced: 7 months ago
JSON representation
CLI App for generating a professional looking README file for your next project.
- Host: GitHub
- URL: https://github.com/blindsweatyhansolo/readmepro
- Owner: blindsweatyhansolo
- Created: 2022-04-16T00:35:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-24T23:39:44.000Z (over 3 years ago)
- Last Synced: 2025-01-06T06:43:47.958Z (about 1 year ago)
- Topics: inquirer, javascript, markdown, nodejs
- Language: JavaScript
- Homepage:
- Size: 6.01 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ReadMe Pro
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Demo](#demo)
* [Technologies](#technologies)
* [Contributions](#contributions)
* [Additional Information](#additional-information)
## [Description:](#table-of-contents)
ReadMe Pro is a simple command-line interface application that creates clean and professional ReadMe files for your next project. Dynamically creates a markdown text file using prompts from the Inquirer package from npm.
*User Story:*
```
AS a developer
I WANT a README generator
SO THAT I can quickly create a professional README for a new project
```
## [Installation:](#table-of-contents)
To install the required dependencies, run the following command:
```
npm i inquirer
```
## [Demo:](#table-of-contents)
[Demo Video](https://drive.google.com/file/d/1yneeDwRAg8RCV_KNnOGXsQQy0C14MKoD/view)
This application runs from the command line. After installing the required dependencies, run using the following command:
```
node index.js
```
Once completed, check the 'dist' folder for your new Readme!
## [Technologies:](#table-of-contents)
Created using:
* Node.js
* Inquirer Package from NPM
* License Badges and links from [lukas-h](https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba#file-license-badges-md)
## [Contributions:](#table-of-contents)
No contributors currently. Contributions more than welcome. If you are interested please contact me using the info [below](#additional-information)
## [Additional Information:](#table-of-contents)
_If you have any questions about the application, have any notes, or would like to become a contributor, please feel free to contact me_
[GitHub](https://github.com/blindsweatyhansolo)