Skip to content

A README generator to remove the tedious process of updating your README file

License

Notifications You must be signed in to change notification settings

kheller18/readme-generator

Repository files navigation

Readme Generator

license badge

Description

A node.js application that simplifies readme creation for projects.

application screenshot

Table of Contents

  1. Installation
  2. Usage
  3. License
  4. Contributing
  5. Tests
  6. Questions

1. Installation

  1. Download repository
Git clone https://github.com/kheller18/readme-generator
  1. Install dependencies
npm install

2. Usage

node index.js

3. License

MIT License

Copyright (c) 2020 Keenan Heller

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.

4. Contributing

5. Tests

There are no current tests associated with this project.

6. Questions

  • GitHub Profile
  • Email: [email protected]
    • Please feel free to contact me at the email address provided above. I will be happy to answer any questions. Feedback is gladly welcomed and appreciated!

About

A README generator to remove the tedious process of updating your README file

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published