docs: improve readme (#1143)

* readme * typo * gulp * build badge * Update CONTRIBUTING.md * update * Update CONTRIBUTING.md * Update README.md Co-authored-by: Reinaldy Rafli <reinaldyrafli@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Reinaldy Rafli <reinaldyrafli@gmail.com> * Update CONTRIBUTING.md Co-authored-by: Reinaldy Rafli <reinaldyrafli@gmail.com> --------- Co-authored-by: Prakash Senthil Vel <23444145+prakashsvmx@users.noreply.github.com> Co-authored-by: Reinaldy Rafli <reinaldyrafli@gmail.com>
minio · May 15, 2023 · 43d204b · 43d204b
1 parent 613932c
commit 43d204b
Show file tree

Hide file tree

Showing 4 changed files with 50 additions and 14 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,10 +4,30 @@ Fork [minio-js upstream](https://github.com/minio/minio-js/fork) source reposito
 ```bash
 $ git clone https://github.com/$USER_ID/minio-js
 $ cd minio-js
+```
+
+### Install npm dependencies
+
+```bash
 $ npm install
-$ npm test
-$ npm build
-...
+```
+
+### Format code (with prettier)
+
+```shell
+$ npm run format
+```
+
+### Check Code Style
+
+```shell
+$ npm run lint
+```
+
+### Tests
+
+```shell
+$ npm run test
 ```
 
 ###  Developer Guidelines

diff --git a/README.md b/README.md
@@ -26,9 +26,7 @@ npm install -g
 
 ## Using with TypeScript
 
-```sh
-npm install --save-dev @types/minio
-```
+`minio>7.1.0` is shipped with builtin type definition, `@types/minio` is no longer needed.
 
 ## Initialize MinIO Client
 
@@ -244,5 +242,4 @@ The full API Reference is available here.
 
 [Contributors Guide](https://github.com/minio/minio-js/blob/master/CONTRIBUTING.md)
 
-[![Build Status](https://travis-ci.org/minio/minio-js.svg)](https://travis-ci.org/minio/minio-js)
-[![Build status](https://ci.appveyor.com/api/projects/status/1d05e6nvxcelmrak?svg=true)](https://ci.appveyor.com/project/harshavardhana/minio-js)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/minio/minio-js/nodejs.yml)
diff --git a/README_zh_CN.md b/README_zh_CN.md
@@ -10,9 +10,7 @@ MinIO JavaScript Client SDK提供简单的API来访问任何Amazon S3兼容的
 
 ## 使用NPM下载
 
-```sh
-npm install --save minio
-```
+`minio>7.1.0` 拥有自带的类型定义，不再需要安装 `@types/minio`。
 
 ## 下载并安装源码
 

diff --git a/docs/zh_CN/CONTRIBUTING.md b/docs/zh_CN/CONTRIBUTING.md
@@ -1,14 +1,35 @@
 ### 设置你的minio-js Github仓库
 Fork [minio-js upstream](https://github.com/minio/minio-js/fork) 源码仓库到你的个人仓库。
 
-MinIO Javascript使用[gulp](http://gulpjs.com/)来管理它的依赖。
+### 克隆代码
 
 ```bash
 $ git clone https://github.com/$USER_ID/minio-js
 $ cd minio-js
+```
+
+### 安装依赖
+
+```bash
 $ npm install
-$ gulp
-...
+```
+
+### 格式化代码
+
+```shell
+$ npm run format
+```
+
+### 检查代码风格
+
+```shell
+$ npm run lint
+```
+
+### 运行测试
+
+```shell
+$ npm run test
 ```
 
 ###  开发者指南