@ardrive/turbo-sdk 1.0.0-alpha.1 → 1.0.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +13 -13
  2. package/lib/README.md +13 -13
  3. package/lib/package.json +1 -2
  4. package/package.json +1 -2
package/README.md CHANGED
@@ -18,7 +18,7 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionalities for inter
18
18
 
19
19
  - [Contributions](#contributions)
20
20
 
21
- # Installation
21
+ ## Installation
22
22
 
23
23
  ```shell
24
24
  npm install @ardrive/turbo-sdk
@@ -30,13 +30,13 @@ or
30
30
  yarn add @ardrive/turbo-sdk
31
31
  ```
32
32
 
33
- # Usage
33
+ ## Usage
34
34
 
35
35
  The SDK is available in both CommonJS and ESM formats and is compatible with bundlers such as Webpack, Rollup, and ESbuild.
36
36
 
37
- ## Web
37
+ ### Web
38
38
 
39
- # Bundlers (Webpack, Rollup, ESbuild, etc.)
39
+ #### Bundlers (Webpack, Rollup, ESbuild, etc.)
40
40
 
41
41
  ```javascript
42
42
  import { TurboFactory } from '@ardrive/turbo-sdk/web';
@@ -45,7 +45,7 @@ const turbo = TurboFactory.unauthenticated({});
45
45
  const rates = await turbo.getFiatRates();
46
46
  ```
47
47
 
48
- ### Browser
48
+ #### Browser
49
49
 
50
50
  ```html
51
51
  <script src="https://cdn.jsdelivr.net/npm/@ardrive/turbo-sdk"></script>
@@ -55,9 +55,9 @@ const rates = await turbo.getFiatRates();
55
55
  </script>
56
56
  ```
57
57
 
58
- ## NodeJS
58
+ ### NodeJS
59
59
 
60
- ### CommonJS
60
+ #### CommonJS
61
61
 
62
62
  ```javascript
63
63
  const { TurboFactory } = require('@ardrive/turbo-sdk/node');
@@ -75,7 +75,7 @@ const turbo = TurboFactory.unauthenticated({});
75
75
  const rates = await turbo.getFiatRates();
76
76
  ```
77
77
 
78
- ## Typescript
78
+ ### Typescript
79
79
 
80
80
  The SDK provides TypeScript typings. When you import the SDK in a TypeScript project:
81
81
 
@@ -87,14 +87,14 @@ import Ardrive from '@ardrive/turbo-sdk/web';
87
87
 
88
88
  The provided typings (`./lib/types/index.d.ts`) will be automatically recognized, offering type checking and autocompletion benefits.
89
89
 
90
- # APIs (WIP)
90
+ ## APIs (WIP)
91
91
 
92
- ## TurboFactory
92
+ ### TurboFactory
93
93
 
94
94
  - `public()`
95
95
  - `private()`
96
96
 
97
- ## TurboUnauthenticatedClient
97
+ ### TurboUnauthenticatedClient
98
98
 
99
99
  - `getFiatRates()`
100
100
  - `getFiatToAR()`
@@ -104,11 +104,11 @@ The provided typings (`./lib/types/index.d.ts`) will be automatically recognized
104
104
  - `getUploadCosts()`
105
105
  - `uploadSignedDataItem()`
106
106
 
107
- ## TurboAuthenticatedClient
107
+ ### TurboAuthenticatedClient
108
108
 
109
109
  - `getBalance()`
110
110
  - `uploadFile()`
111
111
 
112
- # Contributions
112
+ ## Contributions
113
113
 
114
114
  If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are welcome and encouraged.
package/lib/README.md CHANGED
@@ -18,7 +18,7 @@ Welcome to the `@ardrive/turbo-sdk`! This SDK provides functionalities for inter
18
18
 
19
19
  - [Contributions](#contributions)
20
20
 
21
- # Installation
21
+ ## Installation
22
22
 
23
23
  ```shell
24
24
  npm install @ardrive/turbo-sdk
@@ -30,13 +30,13 @@ or
30
30
  yarn add @ardrive/turbo-sdk
31
31
  ```
32
32
 
33
- # Usage
33
+ ## Usage
34
34
 
35
35
  The SDK is available in both CommonJS and ESM formats and is compatible with bundlers such as Webpack, Rollup, and ESbuild.
36
36
 
37
- ## Web
37
+ ### Web
38
38
 
39
- # Bundlers (Webpack, Rollup, ESbuild, etc.)
39
+ #### Bundlers (Webpack, Rollup, ESbuild, etc.)
40
40
 
41
41
  ```javascript
42
42
  import { TurboFactory } from '@ardrive/turbo-sdk/web';
@@ -45,7 +45,7 @@ const turbo = TurboFactory.unauthenticated({});
45
45
  const rates = await turbo.getFiatRates();
46
46
  ```
47
47
 
48
- ### Browser
48
+ #### Browser
49
49
 
50
50
  ```html
51
51
  <script src="https://cdn.jsdelivr.net/npm/@ardrive/turbo-sdk"></script>
@@ -55,9 +55,9 @@ const rates = await turbo.getFiatRates();
55
55
  </script>
56
56
  ```
57
57
 
58
- ## NodeJS
58
+ ### NodeJS
59
59
 
60
- ### CommonJS
60
+ #### CommonJS
61
61
 
62
62
  ```javascript
63
63
  const { TurboFactory } = require('@ardrive/turbo-sdk/node');
@@ -75,7 +75,7 @@ const turbo = TurboFactory.unauthenticated({});
75
75
  const rates = await turbo.getFiatRates();
76
76
  ```
77
77
 
78
- ## Typescript
78
+ ### Typescript
79
79
 
80
80
  The SDK provides TypeScript typings. When you import the SDK in a TypeScript project:
81
81
 
@@ -87,14 +87,14 @@ import Ardrive from '@ardrive/turbo-sdk/web';
87
87
 
88
88
  The provided typings (`./lib/types/index.d.ts`) will be automatically recognized, offering type checking and autocompletion benefits.
89
89
 
90
- # APIs (WIP)
90
+ ## APIs (WIP)
91
91
 
92
- ## TurboFactory
92
+ ### TurboFactory
93
93
 
94
94
  - `public()`
95
95
  - `private()`
96
96
 
97
- ## TurboUnauthenticatedClient
97
+ ### TurboUnauthenticatedClient
98
98
 
99
99
  - `getFiatRates()`
100
100
  - `getFiatToAR()`
@@ -104,11 +104,11 @@ The provided typings (`./lib/types/index.d.ts`) will be automatically recognized
104
104
  - `getUploadCosts()`
105
105
  - `uploadSignedDataItem()`
106
106
 
107
- ## TurboAuthenticatedClient
107
+ ### TurboAuthenticatedClient
108
108
 
109
109
  - `getBalance()`
110
110
  - `uploadFile()`
111
111
 
112
- # Contributions
112
+ ## Contributions
113
113
 
114
114
  If you encounter any issues or have feature requests, please file an issue on our GitHub repository. Contributions, pull requests, and feedback are welcome and encouraged.
package/lib/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ardrive/turbo-sdk",
3
- "version": "0.0.1",
3
+ "version": "1.0.0-alpha.1",
4
4
  "main": "./lib/node/index.js",
5
5
  "types": "./lib/types/index.d.ts",
6
6
  "type": "module",
@@ -47,7 +47,6 @@
47
47
  "build:esm": "yarn tsc -p tsconfig.node.json && yarn tsc -p tsconfig.web.json && cp package.json README.md LICENSE.md ./lib",
48
48
  "build": "yarn clean && yarn build:web && yarn build:esm",
49
49
  "clean": "rimraf [ lib coverage bundles ]",
50
- "postinstall": "husky install",
51
50
  "lint": "eslint src",
52
51
  "lint:fix": "eslint src --fix",
53
52
  "format": "prettier --check .",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ardrive/turbo-sdk",
3
- "version": "1.0.0-alpha.1",
3
+ "version": "1.0.0-alpha.2",
4
4
  "main": "./lib/node/index.js",
5
5
  "types": "./lib/types/index.d.ts",
6
6
  "type": "module",
@@ -47,7 +47,6 @@
47
47
  "build:esm": "yarn tsc -p tsconfig.node.json && yarn tsc -p tsconfig.web.json && cp package.json README.md LICENSE.md ./lib",
48
48
  "build": "yarn clean && yarn build:web && yarn build:esm",
49
49
  "clean": "rimraf [ lib coverage bundles ]",
50
- "postinstall": "husky install",
51
50
  "lint": "eslint src",
52
51
  "lint:fix": "eslint src --fix",
53
52
  "format": "prettier --check .",