Skip to main content

Simple README.md generator.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readme-cli-1.0.1.tar.gz (3.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page