Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/broderickhywell/professional-read-me-generator

Your time is valuable, right? Then save yourself 15+ minutes by using this app to create and download a professional readme for your project!
https://github.com/broderickhywell/professional-read-me-generator

css developer-tools html html-css-javascript javascript professional-services react reactjs readme readme-generator

Last synced: 16 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
# Professional README Generator

![badmath](https://img.shields.io/badge/Javascript-39.6_percent-yellow)

![badmath](https://img.shields.io/badge/Library-React-yellow)

![badmath](https://img.shields.io/badge/CSS-31.3_percent-blue)

![badmath](https://img.shields.io/badge/HTML-29.1_percent-orange)

![badmath](https://img.shields.io/badge/Drank_Coffee_During_Production-Yes-brown)



## 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](https://brodericks-pro-readme-generator.netlify.app/)



## Screenshot

![app-screenshot](https://github.com/user-attachments/assets/e0cc6ee0-bfc8-4e5d-9535-a4145c819007)



## 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](https://www.netlify.com/) - hosting live application

[professional README.md file guide](https://coding-boot-camp.github.io/full-stack/github/professional-readme-guide) - guide used to create application parameters

[google analytics](https://developers.google.com/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](https://www.linkedin.com/in/broderickhywell/) and 

send me a message or email me at [email protected]!



## Connect

[LinkedIn](https://www.linkedin.com/in/broderickhywell/)  

[Github](https://github.com/BroderickHywell)  

Email: [email protected]