Skip to content

Commit

Permalink
More docs and demo info
Browse files Browse the repository at this point in the history
  • Loading branch information
mario4tier committed Aug 24, 2024
1 parent 55b9ac8 commit da3d2d1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
13 changes: 7 additions & 6 deletions docs/src/demo.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@

# Try It!
# Try It! Free. No Account Required

You can load your own Blob ID with the following URL pattern:
You can load any Blob ID with the following URL pattern:

`https://cdn.suiftly.io/blob/{Your Blob ID}`
`https://cdn.suiftly.io/blob/{Any Blob ID}`

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

Notes:
- The first time will be slow because your blob is being retrieved with Walrus and cached by Suiftly servers and globaly by the CDN.
- For now, the blob size is limited to 200 MiB.
- The CDN has 10 PoPs around the world and is DDoS protected.
- CDN response has proper Content-Type header (e.g. image/png)
- First click is slower because the blob is being retrieved from Walrus and then cached by the CDN.
- Blob size limited to 200 MiB (for devnet).
- DDoS protected with 10 PoPs spread globally.


Stay tuned, this is just the first feature!
14 changes: 10 additions & 4 deletions docs/src/intro.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@

# What is Suiftly?

Global CDN for Walrus
Adds fast Walrus loading to your Web2/Web3 sites with:

(1) Simple CDN links (e.g. `https://cdn.suiftly.io/blob/myblob`)
(2) Safer open-source NPM JS and react package (recommended)
(3) suiftly.site optimized portal (future)

The NPM packages will provide:
- Automatic CDN to Walrus failover
- Optional convenient react components (e.g. `<ImageBlob src="..." blobId="..." />`)
- "Trust your CDN... but verify" feature. Allows your client code to validate the CDN response.

Will allow to swiftly load Blob in various manner:
(1) As a simple CDN link (e.g. https://suiftly.io/blob/myblob)
(2) Using Suiftly NPM package for blob loading and signature verification.

Project Status: **Planning**

Expand Down

0 comments on commit da3d2d1

Please sign in to comment.