Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/zbichsel/professional-readme

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/zbichsel/professional-readme
Owner: zbichsel
License: mit
Created: 2023-07-25T00:45:22.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-07-25T05:14:02.000Z (over 1 year ago)
Last Synced: 2024-11-19T15:58:17.783Z (2 months ago)
Language: JavaScript
Size: 2.18 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # professional-readme

  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

  ## Description

This application is for a README generator using node.js and inquirer. It will allow users to generate a README with content from answers given to the prompted questions. This will allow for a quick professional README to be added to the repository.

  ## Table of Contents

  - [Installation](#installation)

  - [Usage](#usage)

  - [License](#license)

  - [Questions](#questions)

  ## Installation

Git clone the repository.

Please make sure that Inquirer dependency has been downloaded. If not, please run the following command:

`npm i [email protected]`

This will install the Inquirer package and version which is necessary for the application to run in. Learn more about [Inquirier](https://www.npmjs.com/package/inquirer).

  ## Usage

To generate a professional README, please run the following command in your integrated terminal for this repository:

`node index.js`

Answer the following prompt questions and your README will be updated with your input and selections.

  ## License

This project is licensed under MIT. Please check LICENSE document in repository for more information.

  ## How to Contribute

If you would like to contribute to this project, please open a new issue or submit a pull request.

  ## Tests

There are currently no test for this application

  ## Screen Shot

https://github.com/zbichsel/professional-readme/assets/136612956/74adfce8-d736-4f89-a993-79971577f55b

![Screen Shot](./assets/README.png)

![Terminal](./assets/questionsreadme.png)

  ## Questions

  If you have any questions, feel free to reach me at [GitHub](https://github.com/zbichsel) or via email at [[email protected]]([email protected]).