0.0.2 • Published 2 years ago
@fastjsui/fast-readme v0.0.2
English | 中文
🏠 Homepage
From
package.json
to quickly generateREADME.md
orREADME.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
- 🧑 FastJs
- 🌏 Website: http://www.fast-js.com
- 💼 Gitee: @FastJs
🤝 Contributing
Contributions, issues and feature requests are welcome! issues page.
⭐️ Show your support
Give a ⭐️ if this project helped you!
- 💼 Gitee: @FastJs
📝 License
Copyright © 2022 @FastJs. This project is ISC licensed.
This README was generated with ❤️ by fast-readme