docs: update readme

linxianxi · Aug 18, 2023 · 4c26aaf · 4c26aaf
1 parent 3a75155
commit 4c26aaf
Showing 1 changed file with 26 additions and 59 deletions.
diff --git a/README.md b/README.md
@@ -2,11 +2,9 @@
 
 <div align="center">
 
-[//]: # '<img width="160" src="https://avatars.githubusercontent.com/u/17870709?v=4">'
+<h1>react-selectable-box</h1>
 
-<h1>@arvinxu/npm-template</h1>
-
-一个开发 npm 项目的模板
+A React component that allows you to select elements in the drag area using the mouse
 
 [Changelog](./CHANGELOG.md) · [Report Bug][issues-url] · [Request Feature][issues-url]
 
@@ -20,49 +18,37 @@
 
 [![ docs by dumi][dumi-url]](https://d.umijs.org/) [![Build With father][father-url]](https://github.com/umijs/father/)
 
-![](https://github.com/othneildrew/Best-README-Template/raw/master/images/screenshot.png)
-
-<!-- gitpod url -->
-
-[gitpod-badge]: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
-[gitpod-url]: https://gitpod.io/#https://github.com/ant-design/@arvinxu/npm-template
-
 <!-- umi url -->
 
 [dumi-url]: https://img.shields.io/badge/docs%20by-dumi-blue
 [father-url]: https://img.shields.io/badge/build%20with-father-028fe4.svg
 
 <!-- npm url -->
 
-[npm-image]: http://img.shields.io/npm/v/@arvinxu/npm-template.svg?style=flat-square&color=deepgreen&label=latest
-[npm-url]: http://npmjs.org/package/@arvinxu/npm-template
-[npm-size]: https://img.shields.io/bundlephobia/minzip/@arvinxu/npm-template?color=deepgreen&label=gizpped%20size&style=flat-square
-[npm-size-url]: https://packagephobia.com/result?p=@arvinxu/npm-template
+[npm-image]: http://img.shields.io/npm/v/react-selectable-box.svg?style=flat-square&color=deepgreen&label=latest
+[npm-url]: http://npmjs.org/package/react-selectable-box
+[npm-size]: https://img.shields.io/bundlephobia/minzip/react-selectable-box?color=deepgreen&label=gizpped%20size&style=flat-square
+[npm-size-url]: https://packagephobia.com/result?p=react-selectable-box
 
 <!-- coverage -->
 
-[coverage]: https://codecov.io/gh/arvinxx/npm-template/branch/master/graph/badge.svg
-[codecov-url]: https://codecov.io/gh/arvinxx/npm-template/branch/master
+[coverage]: https://codecov.io/gh/linxianxi/react-selectable-box/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/linxianxi/react-selectable-box/branch/master
 
 <!-- Github CI -->
 
-[test-ci]: https://github.com/arvinxx/npm-template/workflows/Test%20CI/badge.svg
-[release-ci]: https://github.com/arvinxx/npm-template/workflows/Release%20CI/badge.svg
-[test-ci-url]: https://github.com/arvinxx/npm-template/actions?query=workflow%3ATest%20CI
-[release-ci-url]: https://github.com/arvinxx/npm-template/actions?query=workflow%3ARelease%20CI
-[download-image]: https://img.shields.io/npm/dm/@arvinxu/npm-template.svg?style=flat-square
-[download-url]: https://npmjs.org/package/@arvinxu/npm-template
+[test-ci]: https://github.com/linxianxi/react-selectable-box/workflows/Test%20CI/badge.svg
+[release-ci]: https://github.com/linxianxi/react-selectable-box/workflows/Release%20CI/badge.svg
+[test-ci-url]: https://github.com/linxianxi/react-selectable-box/actions?query=workflow%3ATest%20CI
+[release-ci-url]: https://github.com/linxianxi/react-selectable-box/actions?query=workflow%3ARelease%20CI
+[download-image]: https://img.shields.io/npm/dm/react-selectable-box.svg?style=flat-square
+[download-url]: https://npmjs.org/package/react-selectable-box
 
 </div>
 
 ## 简介
 
-这是一个开发 npm 项目的模板，具有以下特点：
-
-- 🏗️ **基于 father4 的构建工具**：本项目采用了基于 father4 的构建工具，可以更高效地构建项目，提高开发效率；
-- 📖 **基于 dumi2 的文档工具**：本项目采用了基于 dumi2 的文档工具，可以更方便地编写和管理文档，提高文档的可读性和可维护性；
-- 🚀 **基于 vercel 自动化触发文档站构建**：本项目使用 vercel 自动化触发文档站构建，可以更快地更新文档站，提高用户的使用体验；
-- 📦 **基于 semantic-release 实现 npm 包的自动化发布**：本项目使用 semantic-release 实现 npm 包的自动化发布，可以更方便地管理和发布 npm 包，提高开发效率。
+A React component that allows you to select elements in the drag area using the mouse
 
 ## 快速上手
 
@@ -71,36 +57,17 @@
 推荐使用 `pnpm` 安装
 
 ```bash
-pnpm i @arvinxu/npm-template -S
+pnpm i react-selectable-box
 ```
 
 ### 使用
 
-基于该仓库模板可以快速创建一个 npm 包的工程化脚手架。
+[docs](<[./CHANGELOG.md](https://linxianxi.github.io/react-selectable-box/)>)
 
 ## 迭代记录
 
-2023.06.12 - 完善文档与 README 框架
-
-2022.12.17 - 基于蚂蚁研发技术栈配置完成最新的 npm 研发脚手架
-
 详情：[CHANGELOG](./CHANGELOG.md)
 
-## 🤝 Contributing
-
-<!-- CONTRIBUTION GROUP -->
-
-> 📊 Total: <kbd>**2**</kbd>
-
-<a href="https://github.com/arvinxx" title="arvinxx">
-  <img src="https://avatars.githubusercontent.com/u/28616219?v=4" width="50" />
-</a>
-<a href="https://github.com/actions-user" title="actions-user">
-  <img src="https://avatars.githubusercontent.com/u/65916846?v=4" width="50" />
-</a>
-
-<!-- CONTRIBUTION END -->
-
 <div align="right">
 
 [![][back-to-top]](#readme-top)
@@ -114,28 +81,28 @@ This project is [MIT](./LICENSE) licensed.
 
 <!-- LINK GROUP -->
 
-[profile-url]: https://github.com/arvinxx
+[profile-url]: https://github.com/linxianxi
 
 <!-- SHIELD LINK GROUP -->
 
 [back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
 
 <!-- contributors -->
 
-[contributors-shield]: https://img.shields.io/github/contributors/arvinxx/npm-template.svg?style=flat
-[contributors-url]: https://github.com/arvinxx/npm-template/graphs/contributors
+[contributors-shield]: https://img.shields.io/github/contributors/linxianxi/react-selectable-box.svg?style=flat
+[contributors-url]: https://github.com/linxianxi/react-selectable-box/graphs/contributors
 
 <!-- forks -->
 
-[forks-shield]: https://img.shields.io/github/forks/arvinxx/npm-template.svg?style=flat
-[forks-url]: https://github.com/arvinxx/npm-template/network/members
+[forks-shield]: https://img.shields.io/github/forks/linxianxi/react-selectable-box.svg?style=flat
+[forks-url]: https://github.com/linxianxi/react-selectable-box/network/members
 
 <!-- stargazers -->
 
-[stargazers-shield]: https://img.shields.io/github/stars/arvinxx/npm-template.svg?style=flat
-[stargazers-url]: https://github.com/arvinxx/npm-template/stargazers
+[stargazers-shield]: https://img.shields.io/github/stars/linxianxi/react-selectable-box.svg?style=flat
+[stargazers-url]: https://github.com/linxianxi/react-selectable-box/stargazers
 
 <!-- issues -->
 
-[issues-shield]: https://img.shields.io/github/issues/arvinxx/npm-template.svg?style=flat
-[issues-url]: https://github.com/arvinxx/npm-template/issues/new/choose
+[issues-shield]: https://img.shields.io/github/issues/linxianxi/react-selectable-box.svg?style=flat
+[issues-url]: https://github.com/linxianxi/react-selectable-box/issues/new/choose