@taqueria/plugin-ipfs-pinata 0.8.5 → 0.10.0

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 (5) hide show
  1. package/README.md +67 -0
  2. package/_readme.eta +72 -0
  3. package/package.json +2 -2
  4. package/.parcel-cache/data.mdb +0 -0
  5. package/.parcel-cache/lock.mdb +0 -0
package/README.md ADDED
@@ -0,0 +1,67 @@
1
+ # IPFS Pinata Plugin
2
+
3
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
4
+
5
+ The IPFS Pinata plugin provides a `publish` task to upload metadata, media, or other files to IPFS via Pinata
6
+
7
+
8
+
9
+ ## Requirements
10
+
11
+ - Node.js v16.3 or later
12
+ - Docker v0.8.6 or later
13
+ - A [Pinata](https://app.pinata.cloud) account
14
+ - A Pinata JWT Token added to the project
15
+
16
+ ## Installation
17
+
18
+ To install the IPFS Pinata plugin on a Taqueria project, navigate to the project folder and run:
19
+ ```shell
20
+ taq install @taqueria/plugin-ipfs-pinata
21
+ ```
22
+
23
+ ## Configuration
24
+
25
+ In order for Taqueria to connect to Pinata, you must first add your Pinata JWT token to the project. To do this, follow the steps below:
26
+
27
+ 1. Sign into your Pinata account [here](https://app.pinata.cloud/signin)
28
+ 2. Find your JWT token and copy it
29
+ 3. Create the file `.env` in your Taqueria project
30
+ 4. Add the JWT token to a property called `pinataJwtToken` as shown below:
31
+
32
+ ```json
33
+ pinataJwtToken=eyJhbGc...
34
+ ```
35
+
36
+ ## Usage
37
+
38
+ 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
39
+
40
+ 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
+
42
+ ```shell
43
+ taq publish < path >
44
+ ```
45
+
46
+ ## Tasks
47
+
48
+ ### The `taq publish` Task
49
+
50
+ The `publish` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
51
+
52
+ ```shell
53
+ taq publish < sourceDirectory >
54
+ ```
55
+
56
+ #### Task Properties
57
+
58
+ | attribute | value |
59
+ |------------|:-------------------------------:|
60
+ | task | 'publish' |
61
+ | command | 'publish < path > |
62
+ | aliases | N/A |
63
+
64
+
65
+ ## Plugin Architecture
66
+
67
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
package/_readme.eta ADDED
@@ -0,0 +1,72 @@
1
+ <% if (it.output == "github") { %>
2
+ # IPFS Pinata Plugin
3
+ <% } %>
4
+
5
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK and distributed via NPM
6
+
7
+ The IPFS Pinata plugin provides a `publish` task to upload metadata, media, or other files to IPFS via Pinata
8
+
9
+ <% /* <%~ it.noteOpenAdmonition %>
10
+ In order to connect to Pinata, you will need to first create an account on Pinata, then add your JWT token to the project
11
+ <%= it.closeAdmonition %> */ %>
12
+
13
+
14
+ ## Requirements
15
+
16
+ - Node.js v16.3 or later
17
+ - Docker v0.8.6 or later
18
+ - A [Pinata](https://app.pinata.cloud) account
19
+ - A Pinata JWT Token added to the project
20
+
21
+ ## Installation
22
+
23
+ To install the IPFS Pinata plugin on a Taqueria project, navigate to the project folder and run:
24
+ ```shell
25
+ taq install @taqueria/plugin-ipfs-pinata
26
+ ```
27
+
28
+ ## Configuration
29
+
30
+ In order for Taqueria to connect to Pinata, you must first add your Pinata JWT token to the project. To do this, follow the steps below:
31
+
32
+ 1. Sign into your Pinata account [here](https://app.pinata.cloud/signin)
33
+ 2. Find your JWT token and copy it
34
+ 3. Create the file `.env` in your Taqueria project
35
+ 4. Add the JWT token to a property called `pinataJwtToken` as shown below:
36
+
37
+ ```json
38
+ pinataJwtToken=eyJhbGc...
39
+ ```
40
+
41
+ ## Usage
42
+
43
+ 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
44
+
45
+ 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
+
47
+ ```shell
48
+ taq publish < path >
49
+ ```
50
+
51
+ ## Tasks
52
+
53
+ ### The `taq publish` Task
54
+
55
+ The `publish` task is used for compiling Archetype smart contracts to Michelson and the task has the following structure:
56
+
57
+ ```shell
58
+ taq publish < sourceDirectory >
59
+ ```
60
+
61
+ #### Task Properties
62
+
63
+ | attribute | value |
64
+ |------------|:-------------------------------:|
65
+ | task | 'publish' |
66
+ | command | 'publish < path > |
67
+ | aliases | N/A |
68
+
69
+
70
+ ## Plugin Architecture
71
+
72
+ This is a plugin developed for Taqueria built on NodeJS using the Taqueria Node SDK
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@taqueria/plugin-ipfs-pinata",
3
- "version": "0.8.5",
3
+ "version": "0.10.0",
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.8.5",
36
+ "@taqueria/node-sdk": "^0.10.0",
37
37
  "dotenv": "^16.0.0",
38
38
  "form-data": "^4.0.0",
39
39
  "ipfs-only-hash": "^4.0.0",
package/.parcel-cache/data.mdb DELETED
Binary file
package/.parcel-cache/lock.mdb DELETED
Binary file