mkreadme v0.0.1

mkreadme

mkreadme is a CLI that asks you some questions about your project and creates a beautiful reamde with this information. The basic structure of a beautiful readme is taken from Make a Readme by Danny Guo.

TODO: demo with asciinema

Installation

You can install the CLI globally with npm as a node package:

npm install mkreadme -g

Usage

If you installed the CLI with the global flag, you can use it from anywhere on your system:

mkreadme

Support

If you have any problems using this tool or feature reqeusts, please feel free to open an issue.

Roadmap

MVP

• one
• two

1.0.0

• Demo with asciinema :white_check_mark:
• Important badges

Contributing

You are welcome to contribute and make pull requests. If you want to introduce a new bigger feature you can open an issue to discuss it.

Authors and acknowledgement

• Ityreh

License

GNU GPLv3

Project status

Working on version 1.0