Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve readme #1143

Merged
merged 12 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 deps
trim21 marked this conversation as resolved.
Show resolved Hide resolved

```bash
$ npm install
$ npm test
$ npm build
...
```

### format code (with prettier)
trim21 marked this conversation as resolved.
Show resolved Hide resolved

```shell
$ npm run format
```

### Check Code Style

```shell
$ npm run lint
```

### Tests

```shell
$ npm run test
```

### Developer Guidelines
Expand Down
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 need.
trim21 marked this conversation as resolved.
Show resolved Hide resolved

## Initialize MinIO Client

Expand Down Expand Up @@ -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)
4 changes: 1 addition & 3 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ MinIO JavaScript Client SDK提供简单的API来访问任何Amazon S3兼容的

## 使用NPM下载

```sh
npm install --save minio
```
`minio>7.1.0` 拥有自带的类型定义,不再需要安装 `@types/minio`。

## 下载并安装源码

Expand Down
27 changes: 24 additions & 3 deletions docs/zh_CN/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
trim21 marked this conversation as resolved.
Show resolved Hide resolved
```

### 开发者指南
Expand Down