https://github.com/technicalparadox/readme-js

A professional README generator, powered by Node.js/JavaScript
https://github.com/technicalparadox/readme-js

Last synced: 3 months ago
JSON representation

A professional README generator, powered by Node.js/JavaScript

• Host: GitHub
• URL: https://github.com/technicalparadox/readme-js
• Owner: TechnicalParadox
• Created: 2020-12-18T20:35:04.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-12-23T01:35:51.000Z (over 4 years ago)
• Last Synced: 2025-01-17T04:11:17.304Z (4 months ago)
• Language: JavaScript
• Size: 1.34 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# README.js

##### A JavaScript README.md generator using Node.js and Inquirer.

### License

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

*Click link for license details.*

---------------

## Table of Contents

* [Installation](#installation)

* [Usage](#usage)

* [Credits](#credits)

* [Features](#features)

* [Contribution Guidelines](#contribution-guidelines)

* [Tests](#tests)

* [Questions](#questions)

---------------

## Installation

1. Download source files as .zip or download from releases.

2. Unzip the files into the root directory.

3. Run 'npm install' in root directory.

4. Run 'node index.js' in root directory to launch application.

## Usage

Launch the application and follow the prompts to generate your project's README!

![A screenshot of the application running in a Linux terminal.](./assets/screenshot.png)

## Credits

[Giamo Lao](https://www.github.com/technicalparadox)

## Features

* Node.js

* Inquirer

## Contribution Guidelines

[The Contributor Covenant](https://www.contributor-covenant.org/)

## Tests

* This README was generated using README.js!

## Questions

Any questions should be directed to

[Giamo Lao](https://www.github.com/TechnicalParadox)

[[email protected]](mailto:https://www.github.com/TechnicalParadox)