https://github.com/wayou/mkreadme

generate a README.md file
https://github.com/wayou/mkreadme

npx readme

Last synced: 7 months ago
JSON representation

generate a README.md file

• Host: GitHub
• URL: https://github.com/wayou/mkreadme
• Owner: wayou
• Created: 2019-04-04T17:39:47.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-05T05:23:37.000Z (over 6 years ago)
• Last Synced: 2025-01-23T04:15:06.467Z (9 months ago)
• Topics: npx, readme
• Language: JavaScript
• Homepage:
• Size: 2.93 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
make a readme file




  

    

  

  

      

  



Create a sample README.md file based on [this](https://github.com/wayou/readme-template) template.

## Usage

```sh

$ npx mkreadme [url_for_readme_file]

```

You can optionally specify a sample file to download.

Mostly you may combine this util with some other npx command to generate the essential files to startup a project from scratch, e.g.:

```sh

$ npx license mit > LICENSE && npx mkreadme && npx gitignore node && npx covgen  && yarn init -y

```

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fwayou%2Fmkreadme.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fwayou%2Fmkreadme?ref=badge_large)