https://github.com/gaitherdb/good-readme-generator
Creates a ReadMe.md based on user input in Node.js
https://github.com/gaitherdb/good-readme-generator
inquirer markdown templateliterals
Last synced: 2 months ago
JSON representation
Creates a ReadMe.md based on user input in Node.js
- Host: GitHub
- URL: https://github.com/gaitherdb/good-readme-generator
- Owner: Gaitherdb
- Created: 2021-07-27T21:05:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-01T22:18:05.000Z (almost 4 years ago)
- Last Synced: 2025-01-31T12:12:56.932Z (4 months ago)
- Topics: inquirer, markdown, templateliterals
- Language: JavaScript
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Professional README Generator
## 
## Description
To avoid writing an entire README from scratch for each project, this markdown generator lays out a template and takes user input for project specifics to make a README in no time. Bypass the hassle of searching for your license badge, or writing the same contact instructions with each repo, and only enter the specifics to obtain the perfect README for your project.
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
* [Contributing](#contributing)
* [Tests](#tests)
* [Questions](#questions)
## Installation
To install necessary dependencies, run the following command:
```
npm i inquirer --save
```
## Usage
When node.js is installed and the path is set to the Good-README-Generator folder in the terminal, run the index.js file by typing `node index.js`. Answer each prompt with the specifics to your project.
https://user-images.githubusercontent.com/83731627/127588494-ecb65274-9a27-4aa9-be49-1a54e8220398.mp4
## License
This project is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Contributing
I am the sole author of this repo and I am not currently looking for contributors. If you find an error, please make an issue or contact me directly.
## Tests
This application does not have any tests.
## Questions
If you have any questions about the repo, open an issue or contact me directly at [email protected]. You can find more of my work at [Gaitherdb](https://github.com/Gaitherdb).