feat: adding core ipfs features

MakerXStudio · Dec 23, 2023 · e2aa533 · e2aa533
1 parent a7dda8e
commit e2aa533
Show file tree

Hide file tree

Showing 15 changed files with 7,042 additions and 329 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
diff --git a/.github/workflows/pr.yml → .github/workflows/pr.yaml b/.github/workflows/pr.yml → .github/workflows/pr.yaml
@@ -1,16 +1,20 @@
 name: Pull Request
 
 on:
+  # TODO: NC - Remove main branch trigger
+  push:
+    branches:
+      - main
   pull_request:
-    branches: [ 'main' ]
+    branches: ['main']
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [ 18.x ]
+        node-version: [18.x]
 
     name: Build and test with Node ${{ matrix.node-version }}
     steps:

diff --git a/.github/workflows/release.yml → .github/workflows/release.yaml b/.github/workflows/release.yml → .github/workflows/release.yaml
@@ -2,10 +2,13 @@ name: Release
 on:
   push:
     branches:
-      - main
+      # - main
+      - ignore # TODO: NC - Remove this line and uncomment the line above when ready to release
 
 permissions:
   contents: write
+  packages: write
+  issues: read
 
 jobs:
   release:
@@ -44,5 +47,5 @@ jobs:
       - name: Release package
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npx semantic-release
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+*
+!dist/**
+!readme.md
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # IPFS Storage (ipfs-storage)
 
-> A package that makes interacting with IPFS easier
+> A NodeJS package that makes interacting with IPFS easier
 
 [![npm package][npm-img]][npm-url]
 [![Build Status][build-img]][build-url]
@@ -11,11 +11,14 @@
 ## Install
 
 ```bash
-npm install ipfs-storage --save-dev
+npm install ipfs-storage
 ```
 
 ## Usage
 
+- Depends on node18+
+- Upload files to Pinata
+
 ** 🚨 TODO 🚨 **
 
 _The usage section should be minimal. Enough to demo the package, but not overload the reader_
@@ -31,4 +34,5 @@ _The usage section should be minimal. Enough to demo the package, but not overlo
 [semantic-release-img]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
 [semantic-release-url]: https://github.com/semantic-release/semantic-release
 
-TODO: NC - Make sure this package is private
+TODO: NC - Finalise readme
+TODO: NC - Add tests