New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

mkreadme

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

mkreadme

A CLI for creating beautiful and useful readme files.

0.0.1
latest
Source
npm

Version published: 3 years ago

Weekly downloads: 3

Maintainers: 1

Weekly downloads

Created: 3 years ago

Source

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.

GitHub package.json version npm

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

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

FAQs

What is mkreadme?

Is mkreadme popular?

Is mkreadme well maintained?

Package last updated on 22 Oct 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install