🔥README写不好，怎么会有人想给你star⭐️？

前言

程序员是很老实本分，勤勤恳恳的一种人，没有啥花花肠子，你能用他写的东西，他就非常开心😄，是的，很容易满足

所以为啥程序员又叫码农呢，因为程序员有农民工的朴实，憨厚，默默无闻的工作品质而又敬业，很好驾驭，所以如果你身边有个程序员就嫁了吧，没错的

但是因为程序员没啥心眼，也不愿意花时间做推广，只在心里默默埋下一颗种子，希望有一天他写的库能够有人看到，有人用到。这无异于在大海里投下一个漂流瓶，希望一个美女能够捡到。

回归正题，你写了一个库，如何去做推广，怎么让其他人快速知道你做了什么，怎么知道你这个东西比其他人的好，怎么快速了解你这个东西能给他们带来更多的价值呢？

这就引出了我们今天的主角，README，一个快速介绍自己的文档，写好他，你才能脱颖而出

为什么写好readme很重要？

推广: 想象你写了一个库，你想推广这个库，想更多的人给你star⭐️。别人怎么了解你这个库，你这个库有什么优点么？你觉得别人会一上来就去你的src/app.js里面看么？如果你的readme写的很一般，是没人会关注你的库的，更没办法去推广
传承: 你写的库，是要传承下去的，是要别人能读的懂的，方便其他人的参与，包括也让自己能读懂。你想想如果一个库，过了一年后，连你自己都读不懂，你觉得这样的库，会传承下去么？

为什么要写文章？

真的要写出一篇好的readme并没有那么简单，需要很多步骤和材料

一个好的readme的都要有哪些内容

标题 Title

标题这没什么说的，取一个好的标题能帮助用户快速理解你的项目是关于什么的

标题也支持html格式，这给我们提供了很大的便利

html 复制代码

<p align="center">
<img src="https://pic4.zhimg.com/v2-d49c9c9eafa636c9707ac5b6d889a3fe_1440w.jpg" style="width:200px;" />
</p>

<h1 align="center">Smarty-Koa-CLI</h1>

<p align="center">
🛠️Koa快速开发的标准工具
</p>

Banner图片就像一个log，你想给你的项目找一个什么标志作为logo。

因为我的项目是一个koa脚手架工具，所以我就找了koa官网的图片作为log

Badges 徽章

我们要添加哪些徽章？

可以参考moment仓库

至少应该添加npm版本，downloads下载量，license，测试覆盖率coverage徽章

首先打开shields.io/badges/stat... 网站

比如我们要设置npm的package版本

我们先找到version

然后再找version下的npm

填入你的packageName名称

然后点击excute

下面就会显示你的npm版本徽章

我们可以选择URL中的地址，也可以选择MarkDown的地址，粘贴到自己的readme项目中

Features 特性

这部分可以认为是一个 Description ，也就是具体说明这个库的功能。这部分主要是为了描述项目的重点功能。本项目属于工程化学习，所以我的重点是介绍技术栈，这样大家比较容易了解到通过本项目可以学习到什么。

markdown 复制代码

## Features

- 基于lerna的脚手架工具
- 内置路由、构建、部署、Lint 等，仅需一个 Smarty-Koa-CLI依赖即可上手开发。
- 多种Koa模板可供选择，快速生成项目

Install & Quick Start 安装 & 快速指南

为了让用户快速上手，这部分一般都会在第一屏出现。

js 复制代码

## Install


首先进行全局安装
npm i smarty-koa-cli -g

# OR

yarn global add smarty-koa-cli

Quick Start 快速开始也是同样的要求，尽量用最精华的代码让用户感受到项目的强大。

csharp 复制代码

## Quick Start

smarty-koa-cli init firstProject

如果你的项目具备文档网站，好的方法是将用户引导到网站中去。因为网站有更好的阅读体验，可以呈现更为系统的内容。

License

这部分会引用开源证书链接并且填写上 Copyright 信息。

总结

这样，一个简洁且不错的README就被我们搞定了

Y-wson/Smarty-Koa-CLI: Koa快速开发的标准工具 (github.com)

我们只有写好README才能被更多的人知道我们库，才能更好的推广，你自己都不对自己的作品下点功夫，怎么能指望别人喜欢呢，你说是吧

参考

$[基于 Vite 的组件库工程化实战---编写标准的README](https://juejin.cn/book/7117582869358182403 "https://juejin.cn/book/7117582869358182403")$