@taqueria/plugin-ipfs-pinata 0.21.13 → 0.21.23

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 (3) hide show
  1. package/README.md +12 -13
  2. package/_readme.eta +12 -13
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -1,19 +1,18 @@
1
1
  # IPFS Pinata Plugin
2
2
 
3
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
4
-
5
3
  The IPFS Pinata plugin provides a `publish` task to upload metadata, media, or other files to IPFS via Pinata
6
4
 
7
5
  The IPFS Pinata plugin also provides a `pin` task to link any existing files on Pinata to your Pinata account
8
6
 
9
7
 
10
-
8
+
11
9
  ## Requirements
12
10
 
13
- - Node.js v16.3 or later
14
- - Docker v0.8.6 or later
11
+ - Taqueria v0.20.2 or later
12
+ - Node.js v16.17.1 or later
13
+ - Docker v20.10.12 or later
15
14
  - A [Pinata](https://app.pinata.cloud) account
16
- - A Pinata JWT Token added to the project
15
+ - A Pinata JWT Token added to a `.env` file in the project folder
17
16
 
18
17
  ## Installation
19
18
 
@@ -39,10 +38,10 @@ pinataJwtToken=eyJhbGc...
39
38
 
40
39
  The IPFS Pinata plugin exposes a `publish` task which uploads one or more files to IPFS via Pinata, and stores the results in Taqueria State
41
40
 
42
- You will first need to create a new directory in your project and add any metadata or media files you would like to upload to it. Once you have a directory in your project with one or more files to upload, you can run:
41
+ You will first need to create a new directory in your project and add any metadata or media files you would like to upload to Pinata. Once you have a directory in your project with one or more files to upload, you can run:
43
42
 
44
43
  ```shell
45
- taq publish < path >
44
+ taq publish <pathToFile>
46
45
  ```
47
46
 
48
47
  The IPFS Pinata plugin exposes a `pin` task which links files already existing on Pinata to your Pinata account
@@ -50,7 +49,7 @@ The IPFS Pinata plugin exposes a `pin` task which links files already existing o
50
49
  You will need to find the CID for a file on Pinata then use that to pin the file to your account that is linked with the JWT you're using
51
50
 
52
51
  ```shell
53
- taq pin < hash >
52
+ taq pin <fileHash>
54
53
  ```
55
54
 
56
55
  ## Tasks
@@ -60,7 +59,7 @@ taq pin < hash >
60
59
  The `publish` task is used for uploading files/directories of files to IPFS and the task has the following structure:
61
60
 
62
61
  ```shell
63
- taq publish < sourceDirectory >
62
+ taq publish <sourceDirectory>
64
63
  ```
65
64
 
66
65
  #### Task Properties
@@ -68,7 +67,7 @@ taq publish < sourceDirectory >
68
67
  | attribute | value |
69
68
  |------------|:-------------------------------:|
70
69
  | task | 'publish' |
71
- | command | 'publish < path > |
70
+ | command | 'publish < sourceDirectory >' |
72
71
  | aliases | N/A |
73
72
 
74
73
  ### The `taq pin` Task
@@ -84,10 +83,10 @@ taq pin < hash >
84
83
  | attribute | value |
85
84
  |------------|:-------------------------------:|
86
85
  | task | 'pin' |
87
- | command | 'pin < hash > |
86
+ | command | 'pin < fileHash >' |
88
87
  | aliases | N/A |
89
88
 
90
89
 
91
90
  ## Plugin Architecture
92
91
 
93
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
92
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
package/_readme.eta CHANGED
@@ -2,8 +2,6 @@
2
2
  # IPFS Pinata Plugin
3
3
  <% } %>
4
4
 
5
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
6
-
7
5
  The IPFS Pinata plugin provides a `publish` task to upload metadata, media, or other files to IPFS via Pinata
8
6
 
9
7
  The IPFS Pinata plugin also provides a `pin` task to link any existing files on Pinata to your Pinata account
@@ -12,13 +10,14 @@ The IPFS Pinata plugin also provides a `pin` task to link any existing files on
12
10
  In order to connect to Pinata, you will need to first [register](https://app.pinata.cloud/register) an account on Pinata, then add your JWT token to the project
13
11
  <%= it.closeAdmonition %> */ %>
14
12
 
15
-
13
+
16
14
  ## Requirements
17
15
 
18
- - Node.js v16.3 or later
19
- - Docker v0.8.6 or later
16
+ - Taqueria v0.20.2 or later
17
+ - Node.js v16.17.1 or later
18
+ - Docker v20.10.12 or later
20
19
  - A [Pinata](https://app.pinata.cloud) account
21
- - A Pinata JWT Token added to the project
20
+ - A Pinata JWT Token added to a `.env` file in the project folder
22
21
 
23
22
  ## Installation
24
23
 
@@ -44,10 +43,10 @@ pinataJwtToken=eyJhbGc...
44
43
 
45
44
  The IPFS Pinata plugin exposes a `publish` task which uploads one or more files to IPFS via Pinata, and stores the results in Taqueria State
46
45
 
47
- You will first need to create a new directory in your project and add any metadata or media files you would like to upload to it. Once you have a directory in your project with one or more files to upload, you can run:
46
+ You will first need to create a new directory in your project and add any metadata or media files you would like to upload to Pinata. Once you have a directory in your project with one or more files to upload, you can run:
48
47
 
49
48
  ```shell
50
- taq publish < path >
49
+ taq publish <pathToFile>
51
50
  ```
52
51
 
53
52
  The IPFS Pinata plugin exposes a `pin` task which links files already existing on Pinata to your Pinata account
@@ -55,7 +54,7 @@ The IPFS Pinata plugin exposes a `pin` task which links files already existing o
55
54
  You will need to find the CID for a file on Pinata then use that to pin the file to your account that is linked with the JWT you're using
56
55
 
57
56
  ```shell
58
- taq pin < hash >
57
+ taq pin <fileHash>
59
58
  ```
60
59
 
61
60
  ## Tasks
@@ -65,7 +64,7 @@ taq pin < hash >
65
64
  The `publish` task is used for uploading files/directories of files to IPFS and the task has the following structure:
66
65
 
67
66
  ```shell
68
- taq publish < sourceDirectory >
67
+ taq publish <sourceDirectory>
69
68
  ```
70
69
 
71
70
  #### Task Properties
@@ -73,7 +72,7 @@ taq publish < sourceDirectory >
73
72
  | attribute | value |
74
73
  |------------|:-------------------------------:|
75
74
  | task | 'publish' |
76
- | command | 'publish < path > |
75
+ | command | 'publish < sourceDirectory >' |
77
76
  | aliases | N/A |
78
77
 
79
78
  ### The `taq pin` Task
@@ -89,10 +88,10 @@ taq pin < hash >
89
88
  | attribute | value |
90
89
  |------------|:-------------------------------:|
91
90
  | task | 'pin' |
92
- | command | 'pin < hash > |
91
+ | command | 'pin < fileHash >' |
93
92
  | aliases | N/A |
94
93
 
95
94
 
96
95
  ## Plugin Architecture
97
96
 
98
- This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
97
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-ipfs-pinata",
3
- "version": "0.21.13",
3
+ "version": "0.21.23",
4
4
  "description": "A plugin for Taqueria providing ipfs publishing and pinning using the Pinata service",
5
5
  "keywords": [
6
6
  "taqueria",
@@ -33,7 +33,7 @@
33
33
  "directory": "taqueria-plugin-ipfs-pinata"
34
34
  },
35
35
  "dependencies": {
36
- "@taqueria/node-sdk": "^0.21.13",
36
+ "@taqueria/node-sdk": "^0.21.23",
37
37
  "dotenv": "^16.0.0",
38
38
  "form-data": "^4.0.0",
39
39
  "ipfs-only-hash": "^4.0.0",