README 中要做的 5 件最棒的事情！

什么是 README 徽章？

这里有 5 个必备的 README 徽章！

结论

README.md 是您的代码的登录页面。

如果您正在构建一个开源存储库，README 是整个存储库中最重要的文件。

它不仅要看起来好看，而且读起来也要顺畅。

它应该告诉读者一切。

• 用法

• 安装

• 网站

• 版本

• 测试失败还是通过？

• 平均活动量

• 用户评价

• 执照

• GitHub 上的 Star Gazers

• 还有更多...

好消息是，上述大部分信息只需几个动态 SVG 元素即可表达！

您已经在每个著名的存储库中看到过它们。

我非常喜欢Ahmed Awais 先生撰写 README 的方式。点击此处查看示例。

什么是 README 徽章？

看看这个👇

你的徽章不必那么无趣。

您可以在此处查看所有可使用的徽章。

这里有 5 个必备的 README 徽章！

1.🧪🧪🧪 Travis Tests Status

这是我的 NPM 包的当前 Travis 状态🔰

您可以通过粘贴以下语法在自述文件中获取徽章...

用真实数据替换:githubUsername和。:repository

![Travis Status](https://img.shields.io/travis/:githubUsername/:repository)

2.⭐️⭐️⭐️ Rate on pkgreview.dev

pkgreview.dev是一款可供用户评论和评分 NPM 软件包的应用程序。用户可以在应用程序上为您的软件包撰写评价。

为了鼓励他们撰写证词/评论...您可以在 README 中添加此内容👇

您可以通过粘贴以下语法在自述文件中获取徽章...

替换<package-name>为真实的软件包名称。您可以在pkgreview.dev上查看软件包名称和 URL 。

| **Like us a lot?** Help others know why you like us! **Review this package on [pkgreview.dev](https://pkgreview.dev/npm/<package-name>)** | ➡   | [![Review us on pkgreview.dev](https://i.ibb.co/McjVMfb/pkgreview-dev.jpg)](https://pkgreview.dev/npm/<package-name>) |
| ----------------------------------------------------------------------------------------------------------------------------------------- | --- | --------------------------------------------------------------------------------------------------------------------- |

3.🔰🔰🔰 NPM Downloads Badge

下图显示了上周在 NPM 上下载React 的次数……

您可以通过粘贴以下语法在自述文件中获取徽章...

:packageName用 NPM 包 slug/name替换。

![NPM Downloads](https://img.shields.io/npm/dw/:packageName)

4.📝📝📝 License Badge

人们应该知道你的仓库使用的是什么许可证。如果你的仓库使用 NPM，你可以动态获取许可证并获得徽章，就像这样 👇

您可以通过粘贴以下语法在自述文件中获取徽章...

:packageName用 NPM 包 slug/name替换。

![NPM License](https://img.shields.io/npm/l/:packageName)

5.🐦🐦🐦 Twitter Badge

如果您有存储库的 Twitter 帐户，或者您作为存储库的维护者拥有 Twitter 帐户，则必须显示动态 Twitter 徽章！

您可以通过粘贴以下语法在自述文件中获取徽章...

替换:twitterHandle为您的 Twitter 用户名。

[![Twitter](https://img.shields.io/twitter/follow/:twitterHandle.svg?style=social&label=@:twitterHandle)](https://twitter.com/:twitterHandle)

那只是表面上的划痕！

如果您使用shields.io的 SVG，README 的可能性是无穷无尽的。

您可以使用它创建各种自定义和动态 README SVG 徽章...看一看！

有了它，您可以为以下内容创建徽章...

• NPM 包

• WordPress插件

• 特拉维斯测试

• CircleCI 测试

• online带有实时计数的 Discord 徽章

• Twitter 粉丝数量

• GitHub 统计信息

• OpenCollective 资助

• 正常运行时间监视器

• GitHub Stargazers

• 还有更多！

结论

README 徽章很有用。它们提供了许多见解，而且在 GitHub 和 NPM 等包管理器上看起来也很酷。

关于我

我是 Kumar Abhirup，一名来自印度的 16 岁 JavaScript React 开发人员，我每天都在学习新事物。

在 Twitter 上与我联系🐦
我的个人网站和作品集🖥️

在下面评论您更好的方法和建议以改进这篇文章。:)