Skip to content
This repository has been archived by the owner on Jan 1, 2025. It is now read-only.

Commit

Permalink
Improve package.json and fix typos (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
shomix authored Feb 14, 2023
1 parent 7c9bf43 commit b0a219b
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
4 changes: 2 additions & 2 deletions packages/storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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
Expand Down
16 changes: 13 additions & 3 deletions packages/storage/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand All @@ -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",
Expand Down

0 comments on commit b0a219b

Please sign in to comment.