Commit b7bc4933 authored by lijingang's avatar lijingang

Update package name to @youdatasum/client-s3 and add repository URL

parent 9dc4164f
Pipeline #292 canceled with stages
# @youdatasum/ss3ops # @youdatasum/client-s3
S3 operations client for internal use. S3 operations client for internal use.
...@@ -7,7 +7,7 @@ S3 operations client for internal use. ...@@ -7,7 +7,7 @@ S3 operations client for internal use.
### As a global CLI tool ### As a global CLI tool
```bash ```bash
npm install -g @youdatasum/ss3ops npm install -g @youdatasum/client-s3
``` ```
Or via GitLab npm registry (internal). Alternatively, install directly from GitLab repository: Or via GitLab npm registry (internal). Alternatively, install directly from GitLab repository:
...@@ -19,7 +19,7 @@ npm install -g git+ssh://git@git.youdatasum.com:ljg/client-s3.git ...@@ -19,7 +19,7 @@ npm install -g git+ssh://git@git.youdatasum.com:ljg/client-s3.git
### As a library in your project ### As a library in your project
```bash ```bash
npm install @youdatasum/ss3ops npm install @youdatasum/client-s3
``` ```
Or via Git: Or via Git:
...@@ -54,7 +54,7 @@ ss3ops list <bucket> [prefix] ...@@ -54,7 +54,7 @@ ss3ops list <bucket> [prefix]
### Node.js library ### Node.js library
```javascript ```javascript
const { s3, downloadFileFromS3, uploadFileToS3, uploadFolderToS3, downloadS3Folder } = require('@youdatasum/ss3ops'); const { s3, downloadFileFromS3, uploadFileToS3, uploadFolderToS3, downloadS3Folder } = require('@youdatasum/client-s3');
// Use the pre-configured S3 client (connected to internal RustFS endpoint) // Use the pre-configured S3 client (connected to internal RustFS endpoint)
await s3.send(...); await s3.send(...);
......
{ {
"name": "@youdatasum/ss3ops", "name": "@youdatasum/client-s3",
"version": "1.0.0", "version": "1.0.0",
"description": "S3 operations client for internal use", "description": "S3 operations client for internal use",
"main": "lib/index.js", "main": "lib/index.js",
...@@ -12,8 +12,12 @@ ...@@ -12,8 +12,12 @@
"keywords": ["s3", "aws", "client", "internal"], "keywords": ["s3", "aws", "client", "internal"],
"author": "Youdatasum", "author": "Youdatasum",
"license": "MIT", "license": "MIT",
"repository": {
"type": "git",
"url": "git+ssh://git@git.youdatasum.com:ljg/client-s3.git"
},
"publishConfig": { "publishConfig": {
"registry": "https://gitlab.example.com/api/v4/projects/<project_id>/packages/npm/" "registry": "https://git.youdatasum.com/api/v4/projects/<project_id>/packages/npm/"
}, },
"dependencies": { "dependencies": {
"@aws-sdk/client-s3": "^3.0.0", "@aws-sdk/client-s3": "^3.0.0",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment