|
преди 3 години | |
---|---|---|
.vscode | преди 3 години | |
example | преди 3 години | |
src | преди 3 години | |
.gitignore | преди 4 години | |
README.md | преди 3 години | |
package.json | преди 3 години | |
pm2.config.js | преди 3 години | |
tsconfig.json | преди 4 години | |
yarn.lock | преди 3 години |
为您设计的项目,写下初衷、理念和目标。对创建和维护项目背后的动机,作简短的阐述,这应该可以解释为什么该项目存在。
说明用户在安装和使用前,需要准备的一些先决条件,譬如:您需要安装或升级 Node.js(> = 12.*
,Npm 版本 >= 6.14.8
,Yarn 作为首选)。
yarn
在特定的生态系统中,可能存在一种通用的安装方式,例如使用Yarn,NuGet或Homebrew。但是,请考虑是否有可能正在阅读README的人是新手,并且需要更多指导。
yarn start
自由地使用示例,并尽可能显示预期的输出。内联您可以演示的最小用法示例很有帮助,同时提供指向更复杂示例的链接(如果它们太长而无法合理地包含在自述文件中)。
yarn dev
自由地使用示例,并尽可能显示预期的输出。内联您可以演示的最小用法示例很有帮助,同时提供指向更复杂示例的链接(如果它们太长而无法合理地包含在自述文件中)。
包括 logo / demo 截图等。
告诉人们他们可以去哪里寻求帮助。它可以是 issue 跟踪器,聊天室,电子邮件地址等的任意组合。
npm test
用代码示例描述并展示如何运行测试。
如果您对将来的发行版有任何想法,最好在 README 文件中列出它们。
欢迎提出请求。对于重大更改,请先打开一个 issue,以讨论您要更改的内容。请确保适当更新测试。
向那些为该项目做出贡献的人表示感谢。
版权所有 (c) 2021-至今,您的名字。
如果您没有足够的精力或时间来完成项目,请在 README 文件的顶部添加注释,指出开发速度已减慢或完全停止。可能有人会选择 fork 您的项目,或者,以维护者或所有者的身份自愿加入,从而使您的项目继续进行下去。您也可以明确要求维护者。