Skip to content

Commit

Permalink
Replaces Minio refs with MinIO and minio.io links with min.io (#762)
Browse files Browse the repository at this point in the history
  • Loading branch information
ebozduman authored and kannappanr committed Apr 5, 2019
1 parent 052416e commit f2c3731
Show file tree
Hide file tree
Showing 47 changed files with 129 additions and 129 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Setup your minio-js Github Repository
Fork [minio-js upstream](https://github.com/minio/minio-js/fork) source repository to your own personal repository.

Minio Javascript library uses gulp for its dependency management http://gulpjs.com/
MinIO Javascript library uses gulp for its dependency management http://gulpjs.com/

```bash
$ git clone https://github.com/$USER_ID/minio-js
Expand Down
4 changes: 2 additions & 2 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# For maintainers only
Minio JS SDK uses [npm4+](https://www.npmjs.org/) build system.
MinIO JS SDK uses [npm4+](https://www.npmjs.org/) build system.

## Responsibilities
Go through [Maintainer Responsibility Guide](https://gist.github.com/abperiasamy/f4d9b31d3186bbd26522).
Expand Down Expand Up @@ -40,7 +40,7 @@ $ npm publish
```

### Tag
Tag and sign your release commit, additionally this step requires you to have access to Minio's trusted private key.
Tag and sign your release commit, additionally this step requires you to have access to MinIO's trusted private key.
```
$ export GNUPGHOME=/media/${USER}/minio/trusted
$ git tag -s 3.2.1
Expand Down
68 changes: 34 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Minio JavaScript Library for Amazon S3 Compatible Cloud Storage [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io)
# MinIO JavaScript Library for Amazon S3 Compatible Cloud Storage [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)

[![NPM](https://nodei.co/npm/minio.png)](https://nodei.co/npm/minio/)

The Minio JavaScript Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.
The MinIO JavaScript Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.

This quickstart guide will show you how to install the client SDK and execute an example JavaScript program. For a complete list of APIs and examples, please take a look at the [JavaScript Client API Reference](https://docs.minio.io/docs/javascript-client-api-reference) documentation.
This quickstart guide will show you how to install the client SDK and execute an example JavaScript program. For a complete list of APIs and examples, please take a look at the [JavaScript Client API Reference](https://docs.min.io/docs/javascript-client-api-reference) documentation.

This document assumes that you have a working [nodejs](http://nodejs.org/) setup in place.

Expand All @@ -30,9 +30,9 @@ npm install -g
npm install --save-dev @types/minio
```

## Initialize Minio Client
## Initialize MinIO Client

You need five items in order to connect to Minio object storage server.
You need five items in order to connect to MinIO object storage server.


| Params | Description |
Expand Down Expand Up @@ -60,7 +60,7 @@ var minioClient = new Minio.Client({

This example program connects to an object storage server, makes a bucket on the server and then uploads a file to the bucket.

We will use the Minio server running at [https://play.minio.io:9000](https://play.minio.io:9000) in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.
We will use the MinIO server running at [https://play.min.io:9000](https://play.min.io:9000) in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

#### file-uploader.js

Expand Down Expand Up @@ -113,49 +113,49 @@ mc ls play/europetrip/

The full API Reference is available here.

* [Complete API Reference](https://docs.minio.io/docs/javascript-client-api-reference)
* [Complete API Reference](https://docs.min.io/docs/javascript-client-api-reference)

### API Reference : Bucket Operations

* [`makeBucket`](https://docs.minio.io/docs/javascript-client-api-reference#makeBucket)
* [`listBuckets`](https://docs.minio.io/docs/javascript-client-api-reference#listBuckets)
* [`bucketExists`](https://docs.minio.io/docs/javascript-client-api-reference#bucketExists)
* [`removeBucket`](https://docs.minio.io/docs/javascript-client-api-reference#removeBucket)
* [`listObjects`](https://docs.minio.io/docs/javascript-client-api-reference#listObjects)
* [`listObjectsV2`](https://docs.minio.io/docs/javascript-client-api-reference#listObjectsV2)
* [`listIncompleteUploads`](https://docs.minio.io/docs/javascript-client-api-reference#listIncompleteUploads)
* [`makeBucket`](https://docs.min.io/docs/javascript-client-api-reference#makeBucket)
* [`listBuckets`](https://docs.min.io/docs/javascript-client-api-reference#listBuckets)
* [`bucketExists`](https://docs.min.io/docs/javascript-client-api-reference#bucketExists)
* [`removeBucket`](https://docs.min.io/docs/javascript-client-api-reference#removeBucket)
* [`listObjects`](https://docs.min.io/docs/javascript-client-api-reference#listObjects)
* [`listObjectsV2`](https://docs.min.io/docs/javascript-client-api-reference#listObjectsV2)
* [`listIncompleteUploads`](https://docs.min.io/docs/javascript-client-api-reference#listIncompleteUploads)

### API Reference : File Object Operations

* [`fPutObject`](https://docs.minio.io/docs/javascript-client-api-reference#fPutObject)
* [`fGetObject`](https://docs.minio.io/docs/javascript-client-api-reference#fGetObject)
* [`fPutObject`](https://docs.min.io/docs/javascript-client-api-reference#fPutObject)
* [`fGetObject`](https://docs.min.io/docs/javascript-client-api-reference#fGetObject)

### API Reference : Object Operations

* [`getObject`](https://docs.minio.io/docs/javascript-client-api-reference#getObject)
* [`putObject`](https://docs.minio.io/docs/javascript-client-api-reference#putObject)
* [`copyObject`](https://docs.minio.io/docs/javascript-client-api-reference#copyObject)
* [`statObject`](https://docs.minio.io/docs/javascript-client-api-reference#statObject)
* [`removeObject`](https://docs.minio.io/docs/javascript-client-api-reference#removeObject)
* [`removeIncompleteUpload`](https://docs.minio.io/docs/javascript-client-api-reference#removeIncompleteUpload)
* [`getObject`](https://docs.min.io/docs/javascript-client-api-reference#getObject)
* [`putObject`](https://docs.min.io/docs/javascript-client-api-reference#putObject)
* [`copyObject`](https://docs.min.io/docs/javascript-client-api-reference#copyObject)
* [`statObject`](https://docs.min.io/docs/javascript-client-api-reference#statObject)
* [`removeObject`](https://docs.min.io/docs/javascript-client-api-reference#removeObject)
* [`removeIncompleteUpload`](https://docs.min.io/docs/javascript-client-api-reference#removeIncompleteUpload)

### API Reference : Presigned Operations

* [`presignedGetObject`](https://docs.minio.io/docs/javascript-client-api-reference#presignedGetObject)
* [`presignedPutObject`](https://docs.minio.io/docs/javascript-client-api-reference#presignedPutObject)
* [`presignedPostPolicy`](https://docs.minio.io/docs/javascript-client-api-reference#presignedPostPolicy)
* [`presignedGetObject`](https://docs.min.io/docs/javascript-client-api-reference#presignedGetObject)
* [`presignedPutObject`](https://docs.min.io/docs/javascript-client-api-reference#presignedPutObject)
* [`presignedPostPolicy`](https://docs.min.io/docs/javascript-client-api-reference#presignedPostPolicy)

### API Reference : Bucket Notification Operations

* [`getBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#getBucketNotification)
* [`setBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#setBucketNotification)
* [`removeAllBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#removeAllBucketNotification)
* [`listenBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#listenBucketNotification) (Minio Extension)
* [`getBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#getBucketNotification)
* [`setBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#setBucketNotification)
* [`removeAllBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#removeAllBucketNotification)
* [`listenBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#listenBucketNotification) (MinIO Extension)

### API Reference : Bucket Policy Operations

* [`getBucketPolicy`](https://docs.minio.io/docs/javascript-client-api-reference#getBucketPolicy)
* [`setBucketPolicy`](https://docs.minio.io/docs/javascript-client-api-reference#setBucketPolicy)
* [`getBucketPolicy`](https://docs.min.io/docs/javascript-client-api-reference#getBucketPolicy)
* [`setBucketPolicy`](https://docs.min.io/docs/javascript-client-api-reference#setBucketPolicy)


## Full Examples
Expand Down Expand Up @@ -192,15 +192,15 @@ The full API Reference is available here.
* [get-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-notification.js)
* [set-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-notification.js)
* [remove-all-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/remove-all-bucket-notification.js)
* [listen-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/minio/listen-bucket-notification.js) (Minio Extension)
* [listen-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/minio/listen-bucket-notification.js) (MinIO Extension)

#### Full Examples: Bucket Policy Operations
* [get-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-policy.js)
* [set-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-policy.js)

## Explore Further
* [Complete Documentation](https://docs.minio.io)
* [Minio JavaScript Client SDK API Reference](https://docs.minio.io/docs/javascript-client-api-reference)
* [Complete Documentation](https://docs.min.io)
* [MinIO JavaScript Client SDK API Reference](https://docs.min.io/docs/javascript-client-api-reference)
* [Build your own Shopping App Example- Full Application Example ](https://github.com/minio/minio-js-store-app)

## Contribute
Expand Down
64 changes: 32 additions & 32 deletions README_zh_CN.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 适用于Amazon S3兼容云存储的Minio JavaScript Library [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io)
# 适用于Amazon S3兼容云存储的Minio JavaScript Library [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)

[![NPM](https://nodei.co/npm/minio.png)](https://nodei.co/npm/minio/)

Minio JavaScript Client SDK提供简单的API来访问任何Amazon S3兼容的对象存储服务。
MinIO JavaScript Client SDK提供简单的API来访问任何Amazon S3兼容的对象存储服务。

本快速入门指南将向您展示如何安装客户端SDK并执行示例JavaScript程序。有关API和示例的完整列表,请参阅[JavaScript客户端API参考](https://docs.minio.io/docs/javascript-client-api-reference)文档。
本快速入门指南将向您展示如何安装客户端SDK并执行示例JavaScript程序。有关API和示例的完整列表,请参阅[JavaScript客户端API参考](https://docs.min.io/docs/javascript-client-api-reference)文档。

本文假设你已经安装了[nodejs](http://nodejs.org/)

Expand Down Expand Up @@ -52,7 +52,7 @@ var minioClient = new Minio.Client({

本示例连接到一个对象存储服务,创建一个存储桶并上传一个文件到存储桶中。

我们在本示例中使用运行在 [https://play.minio.io:9000](https://play.minio.io:9000) 上的Minio服务,你可以用这个服务来开发和测试。示例中的访问凭据是公开的。
我们在本示例中使用运行在 [https://play.min.io:9000](https://play.min.io:9000) 上的Minio服务,你可以用这个服务来开发和测试。示例中的访问凭据是公开的。

#### file-uploader.js

Expand Down Expand Up @@ -104,49 +104,49 @@ mc ls play/europetrip/
## API文档

完整的API文档在这里。
* [完整API文档](https://docs.minio.io/docs/javascript-client-api-reference)
* [完整API文档](https://docs.min.io/docs/javascript-client-api-reference)

### API文档 : 操作存储桶

* [`makeBucket`](https://docs.minio.io/docs/javascript-client-api-reference#makeBucket)
* [`listBuckets`](https://docs.minio.io/docs/javascript-client-api-reference#listBuckets)
* [`bucketExists`](https://docs.minio.io/docs/javascript-client-api-reference#bucketExists)
* [`removeBucket`](https://docs.minio.io/docs/javascript-client-api-reference#removeBucket)
* [`listObjects`](https://docs.minio.io/docs/javascript-client-api-reference#listObjects)
* [`listObjectsV2`](https://docs.minio.io/docs/javascript-client-api-reference#listObjectsV2)
* [`listIncompleteUploads`](https://docs.minio.io/docs/javascript-client-api-reference#listIncompleteUploads)
* [`makeBucket`](https://docs.min.io/docs/javascript-client-api-reference#makeBucket)
* [`listBuckets`](https://docs.min.io/docs/javascript-client-api-reference#listBuckets)
* [`bucketExists`](https://docs.min.io/docs/javascript-client-api-reference#bucketExists)
* [`removeBucket`](https://docs.min.io/docs/javascript-client-api-reference#removeBucket)
* [`listObjects`](https://docs.min.io/docs/javascript-client-api-reference#listObjects)
* [`listObjectsV2`](https://docs.min.io/docs/javascript-client-api-reference#listObjectsV2)
* [`listIncompleteUploads`](https://docs.min.io/docs/javascript-client-api-reference#listIncompleteUploads)

### API文档 : 操作文件对象

* [`fPutObject`](https://docs.minio.io/docs/javascript-client-api-reference#fPutObject)
* [`fGetObject`](https://docs.minio.io/docs/javascript-client-api-reference#fGetObject)
* [`fPutObject`](https://docs.min.io/docs/javascript-client-api-reference#fPutObject)
* [`fGetObject`](https://docs.min.io/docs/javascript-client-api-reference#fGetObject)

### API文档 : 操作对象

* [`getObject`](https://docs.minio.io/docs/javascript-client-api-reference#getObject)
* [`putObject`](https://docs.minio.io/docs/javascript-client-api-reference#putObject)
* [`copyObject`](https://docs.minio.io/docs/javascript-client-api-reference#copyObject)
* [`statObject`](https://docs.minio.io/docs/javascript-client-api-reference#statObject)
* [`removeObject`](https://docs.minio.io/docs/javascript-client-api-reference#removeObject)
* [`removeIncompleteUpload`](https://docs.minio.io/docs/javascript-client-api-reference#removeIncompleteUpload)
* [`getObject`](https://docs.min.io/docs/javascript-client-api-reference#getObject)
* [`putObject`](https://docs.min.io/docs/javascript-client-api-reference#putObject)
* [`copyObject`](https://docs.min.io/docs/javascript-client-api-reference#copyObject)
* [`statObject`](https://docs.min.io/docs/javascript-client-api-reference#statObject)
* [`removeObject`](https://docs.min.io/docs/javascript-client-api-reference#removeObject)
* [`removeIncompleteUpload`](https://docs.min.io/docs/javascript-client-api-reference#removeIncompleteUpload)

### API文档 : Presigned操作

* [`presignedGetObject`](https://docs.minio.io/docs/javascript-client-api-reference#presignedGetObject)
* [`presignedPutObject`](https://docs.minio.io/docs/javascript-client-api-reference#presignedPutObject)
* [`presignedPostPolicy`](https://docs.minio.io/docs/javascript-client-api-reference#presignedPostPolicy)
* [`presignedGetObject`](https://docs.min.io/docs/javascript-client-api-reference#presignedGetObject)
* [`presignedPutObject`](https://docs.min.io/docs/javascript-client-api-reference#presignedPutObject)
* [`presignedPostPolicy`](https://docs.min.io/docs/javascript-client-api-reference#presignedPostPolicy)

### API文档 : 存储桶通知

* [`getBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#getBucketNotification)
* [`setBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#setBucketNotification)
* [`removeAllBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#removeAllBucketNotification)
* [`listenBucketNotification`](https://docs.minio.io/docs/javascript-client-api-reference#listenBucketNotification) (Minio Extension)
* [`getBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#getBucketNotification)
* [`setBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#setBucketNotification)
* [`removeAllBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#removeAllBucketNotification)
* [`listenBucketNotification`](https://docs.min.io/docs/javascript-client-api-reference#listenBucketNotification) (MinIO Extension)

### API文档 : 存储桶策略

* [`getBucketPolicy`](https://docs.minio.io/docs/javascript-client-api-reference#getBucketPolicy)
* [`setBucketPolicy`](https://docs.minio.io/docs/javascript-client-api-reference#setBucketPolicy)
* [`getBucketPolicy`](https://docs.min.io/docs/javascript-client-api-reference#getBucketPolicy)
* [`setBucketPolicy`](https://docs.min.io/docs/javascript-client-api-reference#setBucketPolicy)


## 完整示例
Expand Down Expand Up @@ -183,15 +183,15 @@ mc ls play/europetrip/
* [get-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-notification.js)
* [set-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-notification.js)
* [remove-all-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/remove-all-bucket-notification.js)
* [listen-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/minio/listen-bucket-notification.js) (Minio Extension)
* [listen-bucket-notification.js](https://github.com/minio/minio-js/blob/master/examples/minio/listen-bucket-notification.js) (MinIO Extension)

#### 完整示例 : 存储桶策略
* [get-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/get-bucket-policy.js)
* [set-bucket-policy.js](https://github.com/minio/minio-js/blob/master/examples/set-bucket-policy.js)

## 了解更多
* [完整文档](https://docs.minio.io)
* [Minio JavaScript Client SDK API文档](https://docs.minio.io/docs/javascript-client-api-reference)
* [完整文档](https://docs.min.io)
* [MinIO JavaScript Client SDK API文档](https://docs.min.io/docs/javascript-client-api-reference)
* [创建属于你的购物APP-完整示例](https://github.com/minio/minio-js-store-app)

## 贡献
Expand Down
10 changes: 5 additions & 5 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# JavaScript Client API Reference [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io)
# JavaScript Client API Reference [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)

## Initialize Minio Client object.
## Initialize MinIO Client object.

## Minio
## MinIO

```js
var Minio = require('minio')
Expand Down Expand Up @@ -68,7 +68,7 @@ __Parameters__

__Example__

## Create client for Minio
## Create client for MinIO

```js
var Minio = require('minio')
Expand Down Expand Up @@ -975,7 +975,7 @@ minioClient.removeAllBucketNotification('my-bucketname', function(e) {

Listen for notifications on a bucket. Additionally one can provider
filters for prefix, suffix and events. There is no prior set bucket notification
needed to use this API. This is an Minio extension API where unique identifiers
needed to use this API. This is an MinIO extension API where unique identifiers
are regitered and unregistered by the server automatically based on incoming requests.

Returns an `EventEmitter`, which will emit a `notification` event carrying the record.
Expand Down
4 changes: 2 additions & 2 deletions docs/zh_CN/API.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# JavaScript Client API参考文档 [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io)
# JavaScript Client API参考文档 [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)

## 初使化Minio Client object.

## Minio
## MinIO

```js
var Minio = require('minio')
Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### 设置你的minio-js Github仓库
Fork [minio-js upstream](https://github.com/minio/minio-js/fork) 源码仓库到你的个人仓库。

Minio Javascript使用[gulp](http://gulpjs.com/)来管理它的依赖。
MinIO Javascript使用[gulp](http://gulpjs.com/)来管理它的依赖。

```bash
$ git clone https://github.com/$USER_ID/minio-js
Expand Down
Loading

0 comments on commit f2c3731

Please sign in to comment.