fix: test jsr setup

frytg · Dec 18, 2024 · 99e3c9f · 99e3c9f
1 parent 8c3fb3c
commit 99e3c9f
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 6 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -16,8 +16,8 @@ on:
 permissions:
   contents: read
 
-# env:
-# JSR_DEPENDENCIES: "@cross/test @std/assert @std/fmt @frytg/logger @frytg/check-required-env"
+env:
+  JSR_DEPENDENCIES: "@cross/test @std/assert @std/fmt @frytg/logger @frytg/check-required-env"
 # NPM_DEPENDENCIES: "luxon minio sinon"
 
 jobs:
@@ -94,8 +94,8 @@ jobs:
       - name: Bun version
         run: bun --version
 
-      #- name: Install JSR dependencies
-      #  run: bunx jsr add ${{ env.JSR_DEPENDENCIES }}
+      - name: Install JSR dependencies
+        run: bunx jsr add ${{ env.JSR_DEPENDENCIES }}
 
       #- name: Install NPM dependencies
       #  run: bun add ${{ env.NPM_DEPENDENCIES }}
@@ -140,8 +140,8 @@ jobs:
       - name: Node version
         run: node --version
 
-      #- name: Install JSR dependencies
-      #  run: npx jsr add ${{ env.JSR_DEPENDENCIES }}
+      - name: Install JSR dependencies
+        run: npx jsr add ${{ env.JSR_DEPENDENCIES }}
 
       #- name: Install NPM dependencies
       #  run: npm install ${{ env.NPM_DEPENDENCIES }}

diff --git a/storage-s3/README.md b/storage-s3/README.md
@@ -0,0 +1,29 @@
+# Storage (S3) wrapper
+
+[![JSR @frytg/storage-s3](https://jsr.io/badges/@frytg/storage-s3)](https://jsr.io/@frytg/storage-s3)
+[![ci](https://github.com/frytg/utility/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/frytg/utility/actions/workflows/test.yml)
+
+This is a simple opinionated wrapper around the S3 library [MinIO](https://min.io/) to access and manipulate S3 objects.
+
+## Usage
+
+```ts
+import { getObject } from '@frytg/storage-s3';
+
+const object = await getObject('path/to/object.json', { parseJson: true });
+```
+
+## Methods
+
+- [getObject](https://jsr.io/@frytg/storage-s3/doc/~/getObject)
+- [uploadObject](https://jsr.io/@frytg/storage-s3/doc/~/uploadObject)
+- [objectExists](https://jsr.io/@frytg/storage-s3/doc/~/objectExists)
+- [listObjects](https://jsr.io/@frytg/storage-s3/doc/~/listObjects)
+
+## Author
+
+Created by [@frytg](https://github.com/frytg) / [frytg.digital](https://www.frytg.digital)
+
+## License
+
+[Unlicense](https://github.com/frytg/utility/blob/main/LICENSE) - also see [unlicense.org](https://unlicense.org)