README.md

simply-readme

CLI to automatically generate README.md files
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installing
3. Running the tests
4. Usage and Example
5. Roadmap
6. Built Using
7. Authors
8. Acknowledgement
9. License

🧐 About

CLI to automatically generate README.md files

🏁 Getting Started

These instructions tell you how to get simply-readme

Prerequisites

What things you need to install simply-readme

NodeJS 

Installing

A step by step guide that tell you how to Install simply-readme.

npx github:3Samourai/simply-readme

🔧 Running the tests

How to run the automated tests for this system.

npm test

🎈 Usage and Example

⛏️ Built Using

• SimplyREADME - README Generator

✍️ Authors

• 3Samourai - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

Inspiration and References

• readme-md-generator
• Best-README-Template

🎉 License

MIT License