VoIlAlex / readme-cli

README CLI

Simple README.md generator.

Installation

To install type the following in the terminal:

pip install readme-cli

Usage

Command to generate LICENSE.md file looks like:

readme

Or you can specify a variant of the generated README.md:

readme <readme-variant>

Where <readme-variant> is one of:

• small - title, installation, usage
• medium - title, installation, usage, license, contributing
• large - lots of stuff

License

MIT

Contributing

See CONTRIBUTING.md