docs: ✏️ Add codecov badge

ha0z1 · Nov 16, 2023 · d1289ef · d1289ef
1 parent 424c24a
commit d1289ef
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 14 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,3 +1,3 @@
 {
-  "cSpell.words": ["idmp"]
+  "cSpell.words": ["codecov", "idmp", "typeof"]
 }
diff --git a/README.md b/README.md
@@ -2,7 +2,11 @@
 
 ---
 
-An elegant library to solve duplicate and concurrent calls for idempotent functions, pure function. Less than 200b after Gzip
+[![codecov](https://codecov.io/gh/ha0z1/idmp/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ha0z1/idmp/blob/main/src%2Findex.ts)
+[![npm](https://img.shields.io/npm/v/idmp.svg)](https://www.npmjs.com/package/idmp)
+[![contributors](https://img.shields.io/github/contributors/ha0z1/idmp)](https://github.com/ha0z1/idmp/graphs/contributors)
+
+An elegant library to solve duplicate and concurrent calls for idempotent functions, pure function. Less than 200 Bytes after Gzip
 
 English | [简体中文](README.zh-CN.md)
 
@@ -40,22 +44,22 @@ const getInfoById = async (id: string) => {
   return await fetch(API).then((d) => d.json())
 }
 
-// Handle params
+// 处理有入参的场景
 export const getInfoByIdIdmp = (id: string) =>
-  idmp(`/api/your-info?${id}`, () => getInfo(id))
+  idmp(`/api/your-info?${id}`, () => getInfoById(id))
 
-// Or a more generic type juggling, for complex params, idmp will infer the return type automatically, keep it consistent with the original function
+// 或者更通用的类型体操写法，用于复杂的入参，idmp 会自动推导返回值类型，与原函数保持一致
 export const getInfoByIdIdmp = (...args: Parameters<typeof getInfoById>) =>
-  idmp(`/api/your-info?${JSON.stringify(args)}`, () => getInfo(...args))
+  idmp(`/api/your-info?${JSON.stringify(args)}`, () => getInfoById(...args))
 
-// More options
+// 增加更多配置项
 export const getInfoByIdIdmp = (id: string) =>
-  idmp(`/api/your-info?${id}`, () => getInfo(id), {
+  idmp(`/api/your-info?${id}`, () => getInfoById(id), {
     maxAge: 86400 * 1000,
   })
 ```
 
-Then replace `getInfo` with `getInfoIdmp`.
+Then replace `getInfoByIdIdmp` with `getInfoById`.
 
 ## Options
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -2,7 +2,11 @@
 
 ---
 
-一个优雅地解决幂等(idempotent) 函数的重复和并发调用的小库，纯函数，Gzip 后不到 200b
+[![codecov](https://codecov.io/gh/ha0z1/idmp/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ha0z1/idmp/blob/main/src%2Findex.ts)
+[![npm](https://img.shields.io/npm/v/idmp.svg)](https://www.npmjs.com/package/idmp)
+[![contributors](https://img.shields.io/github/contributors/ha0z1/idmp)](https://github.com/ha0z1/idmp/graphs/contributors)
+
+一个优雅地解决幂等(idempotent) 函数的重复和并发调用的小库，纯函数，Gzip 后不到 200 Bytes
 
 [English](README.md) | 简体中文
 
@@ -42,20 +46,20 @@ const getInfoById = async (id: string) => {
 
 // 处理有入参的场景
 export const getInfoByIdIdmp = (id: string) =>
-  idmp(`/api/your-info?${id}`, () => getInfo(id))
+  idmp(`/api/your-info?${id}`, () => getInfoById(id))
 
 // 或者更通用的类型体操写法，用于复杂的入参，idmp 会自动推导返回值类型，与原函数保持一致
 export const getInfoByIdIdmp = (...args: Parameters<typeof getInfoById>) =>
-  idmp(`/api/your-info?${JSON.stringify(args)}`, () => getInfo(...args))
+  idmp(`/api/your-info?${JSON.stringify(args)}`, () => getInfoById(...args))
 
 // 增加更多配置项
 export const getInfoByIdIdmp = (id: string) =>
-  idmp(`/api/your-info?${id}`, () => getInfo(id), {
+  idmp(`/api/your-info?${id}`, () => getInfoById(id), {
     maxAge: 86400 * 1000,
   })
 ```
 
-然后用 `getInfoIdmp` 替换 `getInfo` 方法。
+然后用 `getInfoByIdIdmp` 替换 `getInfoById` 方法。
 
 ## Options