0.0.2 • Published 2 years ago

@fastjsui/fast-readme v0.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

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

ParameterNameDataType
isProjectOnNpmboolean default: false
projectPrerequisites{ "name":"node", "value":">=16.0."}
licensestring default: 'ISC'
licenseUrlstring default:'#'
projectHomepagestring default:'#'
projectDemoUrlstring default:'#'
descriptionstring default:'description'
installCommandstring default:'installCommand'
testCommandstring default:'testCommand'
authorNamestring default:'authorName'
authorWebsitestring default:'#'
authorGithubUsernamestring default:'authorGithubUsername'
issuesUrlstring 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

0.0.2

2 years ago

0.0.1

2 years ago