Skip to content

3Samourai/simply-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project logo

simply-readme

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

View Demo · Report Bug · Request Feature

ContributorsForksStargazersLicense

Table of Contents
  1. About The Project
  2. Getting Started
  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

GIF Example

⛏️ Built Using

✍️ Authors

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

🎉 Acknowledgements

Inspiration and References

🎉 License

MIT License