From b0a219b5b55558251f85fd3146345f0a5cc75e33 Mon Sep 17 00:00:00 2001 From: shomix <100691266+shomix@users.noreply.github.com> Date: Tue, 14 Feb 2023 16:15:02 +0100 Subject: [PATCH] Improve package.json and fix typos (#13) --- package.json | 2 ++ packages/storage/README.md | 4 ++-- packages/storage/package.json | 16 +++++++++++++--- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 8908602a..99805aa0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,8 @@ { "name": "sdk", "version": "0.0.0", + "author": "Spheron Team", + "description": "🧰 Developer toolkits for web3 cloud infrastructure powered by Spheron", "scripts": { "build": "turbo run build", "prettier": "turbo run prettier", diff --git a/packages/storage/README.md b/packages/storage/README.md index bd1ab567..4acd7807 100644 --- a/packages/storage/README.md +++ b/packages/storage/README.md @@ -2,7 +2,7 @@ ### Usage: -In the example bellow you can see how to create an instance of `SpheronClient` and how to upload a file/directory to the specified protocol. +In the example below you can see how to create an instance of `SpheronClient` and how to upload a file/directory to the specified protocol. ``` import SpheronClient, { ProtocolEnum } from "@spheron/storage"; @@ -18,7 +18,7 @@ const { uploadId, bucketId, protocolLink, dynamicLinks } = await client.upload(f - `filePath` - the path to the file/directory that will be uploaded - `configuration` - an object with two parameters: - `configuration.name` - represents the name of the bucket on which you are uploading the data. - - `configuarion.protocol` - a protocol on which the data will be uploaded. The supported protocols are [ `ARWEAVE`, `IPFS`, `FILECOIN`]. + - `configuration.protocol` - a protocol on which the data will be uploaded. The supported protocols are [ `ARWEAVE`, `IPFS`, `FILECOIN`]. - The response of the upload function is an object with parameters: - `uploadId` - the id of the upload - `bucketId` - the id of the bucket diff --git a/packages/storage/package.json b/packages/storage/package.json index c62c60c7..6bf28389 100644 --- a/packages/storage/package.json +++ b/packages/storage/package.json @@ -1,6 +1,18 @@ { "name": "@spheron/storage", - "version": "1.0.0", + "version": "1.0.1", + "description": "Typescript library for uploading files or directory to IPFS, Filecoin or Arweave via Spheron", + "keywords": [ + "Storage", + "Typescript", + "Badass", + "IPFS", + "Filecoin", + "Arweave", + "SDK", + "Upload" + ], + "author": "Spheron Team", "main": "./dist/index.js", "types": "./dist/index.d.ts", "scripts": { @@ -10,8 +22,6 @@ "prettier:check": "prettier --check '**/*.{ts,tsx,json,md,hbs}' --ignore-path .gitignore", "lint": "eslint . --ext .ts" }, - "author": "", - "license": "ISC", "devDependencies": { "@types/node": "^18.13.0", "@typescript-eslint/eslint-plugin": "^5.51.0",