https://github.com/brendan-leighton/readme-generator

CLI program for generating a ReadMe.md
https://github.com/brendan-leighton/readme-generator

Last synced: 18 days ago
JSON representation

CLI program for generating a ReadMe.md

• Host: GitHub
• URL: https://github.com/brendan-leighton/readme-generator
• Owner: Brendan-Leighton
• Created: 2020-08-18T15:11:55.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-08-28T17:16:07.000Z (over 4 years ago)
• Last Synced: 2024-08-01T12:39:05.983Z (5 months ago)
• Language: JavaScript
• Size: 289 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

  

  


  
ReadMe Generator


  [![License][mit]][mit-url]

  

  

  

  

  # Table of Contents

  

  * [About the Project](#about-the-project)

      * [Live Link](#finished-project)

      * [Project Demo](#project-demo)

      * [Built With](#built-with)

  * [Usage](#usage)

  * [License](#license)

  * [Contribution Instructions](#contributions)

  * [Test Instructions](#testing)

  * [Contact / Questions](#contact-or-questions)

  * [Acknowledgements](#acknowledgements)

  

  

  

  

  # About The Project

  

  ## Finished Project

  

  

  You're looking at it! It isn't deployed anywhere, just fork it.

  

  ## Project Demo

  

  [Watch Demo On YouTube](https://www.youtube.com/watch?v=60zCvlJ45mw)

  ## Built With

  NPM:

  * Inquirer

  * Axios

  # Usage

  To create a well written ReadMe with ease. 

  # License

  

  Begin license text.

        

        Copyright 2020 Brendan Leighton

  

        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    

  End license text.

  # Contributions

  After passing tests, check spelling/grammar and write clean code.

  # Testing

  

  No tests, just don't break anything.

  

  # Contact or Questions

  

  * [Email]([email protected])

  * [GitHub](https://github.com/BR3NDAN-L8N)

  * [LinkedIn](https://www.linkedin.com/in/brendan-leighton/)

  

  

  

  

  # Acknowledgements

  NPM, Inquirer, Axios, Google

  

  

[mit]: https://img.shields.io/badge/License-The%20MIT%20License-blue

[mit-url]: https://opensource.org/licenses/MIT