@fastjsui/fast-readme

0.0.2 • Public • Published

🎉🚀Welcome to 🎉 fast-readme 👋

Version License: ISC

English | 中文

🏠 Homepage

From package.json to quickly generate README.md or README.zh-CN.md document

📦 Prerequisites

  • node >=16.14.2

🛠️ Install

pnpm install -g @fastjsui/fast-readme

✍️ Usage

$ fast-readme

🧪 config package.json parameters

ParameterName DataType
isProjectOnNpm boolean default: false
projectPrerequisites [{ "name":"node", "value":">=16.0."}]
license string default: 'ISC'
licenseUrl string default:'#'
projectHomepage string default:'#'
projectDemoUrl string default:'#'
description string default:'description'
installCommand string default:'installCommand'
testCommand string default:'testCommand'
authorName string default:'authorName'
authorWebsite string default:'#'
authorGithubUsername string default:'authorGithubUsername'
issuesUrl string default:'#'

🧑 Author

🤝 Contributing

Contributions, issues and feature requests are welcome! issues page.

⭐️ Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 @FastJs. This project is ISC licensed.


This README was generated with ❤️ by fast-readme

Dependents (0)

Package Sidebar

Install

npm i @fastjsui/fast-readme

Weekly Downloads

0

Version

0.0.2

License

ISC

Unpacked Size

1.22 MB

Total Files

6

Last publish

Collaborators

  • aipeli