46

Generate beautiful README files in 10 seconds

 5 years ago
source link: https://www.tuicool.com/articles/em6j6rA
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

Welcome to readme-md-generator :wave:

CLI that generates beautiful README.md files.

readme-md-generator will suggest you default answers by reading your package.json and git configuration.

:sparkles: Demo

readme-md-generator is able to read your environment (package.json, git config...) to suggest you default answers during the README.md creation process :

RNnumu2.gif

Generated README.md :

UzUzEnM.jpg!web

Example of package.json with good meta data : 

// The package.json is not required to run README-MD-GENERATOR
{
  "name": "readme-md-generator",
  "version": "0.1.3",
  "description": "CLI that generates beautiful README.md files.",
  "author": "Franck Abgrall",
  "license": "MIT",
  "homepage": "https://github.com/kefranabg/readme-md-generator#readme",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/kefranabg/readme-md-generator.git"
  },
  "bugs": {
    "url": "https://github.com/kefranabg/readme-md-generator/issues"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}

:package: Install

With npm :

npm i -g readme-md-generator

With yarn :

yarn global add readme-md-generator

:rocket: Usage

Just run the following command at the root of your project and answer questions :

readme

Contributing

Contributions, issues and feature requests are welcome. Feel free to check issues page if you want to contribute.

Author

:bust_in_silhouette: Franck Abgrall

Show your support

Please :star:️ this repository if this project helped you !

:memo: License

Copyright © 2019 Franck Abgrall .

This project is MIT licensed.

This README was generated with :heart: by readme-md-generator


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK