Skip to content

Commit

Permalink
Update @suiftly/core npm package + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mario4tier committed Aug 28, 2024
1 parent f662043 commit 336badc
Show file tree
Hide file tree
Showing 18 changed files with 361 additions and 542 deletions.
1 change: 1 addition & 0 deletions .vscode/ltex.hiddenFalsePositives.en-US.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"rule":"COMP_THAN","sentence":"^\\Q(First click will be slower as it will be aggregated and cached for the next fast requests)\\E$"}
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,35 @@

Load most Walrus blobs in less than 100 milliseconds!

Join the discussion on [Discord](https://discord.com/invite/Erb6SwsVbH)

# Direct Links
You can load any blob with a direct link:
https://cdn.suiftly.io/blob/{blobID}


Example:
https://cdn.suiftly.io/blob/fK7v0bft1JqVbxQaM_KJAYkejbY9FgU9doqZwg7smw8

First click is slower to perform one-time aggregation and caching for subsequent fast requests.

Suiftly returns proper MIME Content-Type header (e.g. image/png).

# NPM Packages
See [@suiftly/core](https://www.npmjs.com/package/@suiftly/core)

Works for any Web2/Web3 browser and NodeJS apps.

Join the discussion on [Discord](https://discord.com/invite/Erb6SwsVbH)
As simple as `fetchBlob(blobID)`

Features:
- Try CDN first, failover to Walrus
- Blob integrity check.
- Returns standard JS Blob object with proper MIME type.

Installation:
```npm install @suiftly/core```


# Thank you!
- [Mysten Labs](https://mystenlabs.com) and the [Sui foundation](https://sui.io) for their innovations and financial support.
Expand Down
3 changes: 1 addition & 2 deletions dapps/suiftly.walrus.site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
"scripts": {
"dev": "pnpm frontend:dev",
"start": "pnpm dev",
"test": "pnpm backend:test",
"build": "pnpm backend:build && pnpm frontend:build",
"build": "pnpm frontend:build",
"lint": "pnpm frontend:lint",
"format": "pnpm frontend:format",

Expand Down
3 changes: 0 additions & 3 deletions dapps/suiftly.walrus.site/packages/backend/.gitignore

This file was deleted.

3 changes: 0 additions & 3 deletions dapps/suiftly.walrus.site/packages/backend/README.md

This file was deleted.

37 changes: 0 additions & 37 deletions dapps/suiftly.walrus.site/packages/backend/move/greeting/Move.toml

This file was deleted.

This file was deleted.

Loading

0 comments on commit 336badc

Please sign in to comment.