Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moojigc/readme-generator

Uses Inquirer with Node.js to create a readme.md for your GitHub repo.
https://github.com/moojigc/readme-generator

Last synced: about 1 month ago
JSON representation

Uses Inquirer with Node.js to create a readme.md for your GitHub repo.

Host: GitHub
URL: https://github.com/moojigc/readme-generator
Owner: moojigc
Created: 2020-04-08T17:55:16.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2022-07-07T18:23:02.000Z (over 2 years ago)
Last Synced: 2024-10-15T05:26:18.769Z (3 months ago)
Language: JavaScript
Size: 11.2 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 3
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        
# Readme Generator

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) 

Developed by Moojig Battsogt. 



Contact at [email protected].

## Description 

Generates a readme.md based on your GitHub profile and answers to questions through the use of the NodeJS package 'inquirer'

## Table of Contents

* [Installation](#installation)

* [Usage](#usage)

* [Credits](#credits)

* [License](#license)

## Installation

Git clone this repo.

## Usage 

Before you run it in the terminal, you must create a 'config.json' file with your GitHub personal access token. It goes in the utils/ folder.

## Tests

None.

## Questions

Q: Why do I need a config.json file? A: To hide your personal token from the public repo.

## License

ISC License

        Copyright (c) 2020, Moojig Battsogt

        

        Permission to use, copy, modify, and/or distribute this software for any

        purpose with or without fee is hereby granted, provided that the above

        copyright notice and this permission notice appear in all copies.

        

        THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES

        WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF

        MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR

        ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES

        WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN

        ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF

        OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.