Skip to content

Your time is valuable, right? Then save yourself 15+ minutes by using this app to create and download a professional readme for your project!

License

Notifications You must be signed in to change notification settings

BroderickHywell/professional-read-me-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Professional README Generator

badmath badmath badmath badmath badmath

Description

Everyones time is valuable, and one occupation that exaggerates that more than a developer. One task that almost all projects require is a reame.md file. So while these files are relatively simple, especially in the beginning, I have created this application to save you 15+ minutes by just entering your data for your application into the fields, and my application will generate a readme.md file for you that you can download directly into your project. Hope I have helped in your coding journey, and don't forget to bookmark my app for your other projects!

Link

professional readme.md generator

Screenshot

app-screenshot

Usage

Simply enter your project details into the corresponding fields and submit the form by clicking the button or hitting enter. It will create a README.md file for you to download to whatever destination you choose. You can also add as many new inputs as you like for your readme.md file with the input at the bottom of the page.

Credits

netlify - hosting live application professional README.md file guide - guide used to create application parameters google analytics - seeing how many people use my app

License

MIT License

Copyright (c) [year] [fullname]

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.

Contribute

If you have anything you would like to add to this application or another of mine, or if you just want to collaborate with me, connect with me on my Linkedin and send me a message or email me at zerothesu@gmail.com!

Connect

LinkedIn
Github
Email: zerothesu@gmail.com