whoadood / drmb

Dont Read Me Bro is a cli for generating README files

drmb

simple elegant readme generator for busy developers
Explore the docs »

View Demo · Report Bug · Request Feature

Buy me a coffee

Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)

About The Project

DRMB is a README generator for developers who want the hard work put into their project reflected in the projects README. Engineering software at any scale is a lot of work, DRMB is aimed at alleviating some of the workload by offering an elegant, simple solution for project README files. Simply enter the project details an viola!

Built With

(back to top)

Getting Started

To get the project running on your local machine, you will need Node.js and the following installation guide to get started.

Prerequisites

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/whoadood/drmb.git

2. Install NPM packages

   npm install

3. Run in dev mode (rollup compile on save)

   npm run dev

4. Link binary command

   npm link

5. Run CLI

   drmb

(back to top)

Usage

• run command npx drmb from project root
• enter github username
• enter this project name
• enter this project url
• enter a description for this project
• let the magic happen

(back to top)

Roadmap

• Add templates
• Fine tune input prompts
• Add prompt for templates with preview links

(back to top)

Optimizations

While I think prompting users for full descriptions for sections of the readme seems a bit unwieldy for the command line, I do believe there is a happy medium not yet reached, prompting for more accurate details would be a nice to have.

With multiple template options it would be good quality of life to have a set of prompts that work across all templates, however, I think it will have to be fleshed out with specific set of prompts for each template.

Lessons Learned

I have been dealing with imposter syndrome a lot lately and it was suggested to me to tinker around in node making command line interfaces. After revisiting how the event loop works, a lot of node documentation and a handful of tutorials I have made the first project that makes me feel like a programmer. Blocking / non-blocking, synchronous / asynchronus, call stack / queue, cant say that I know a whole lot more about them than I did, but there's definitely an improvement. 🤷

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

whoadood - @whoadood

Project Link: drmb

(back to top)

License

You can check out the full license here

This project is licensed under the terms of the MIT license.