Skip to content

Commit b2ba721

Browse files
committed
chore: update docs
1 parent 581522e commit b2ba721

1 file changed

Lines changed: 11 additions & 3 deletions

File tree

packages/core/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -339,15 +339,23 @@ export interface UriConfig {
339339
```ts
340340
/**
341341
* A Polywrap URI. Some examples of valid URIs are:
342+
* wrap://https/domain.com
342343
* wrap://ipfs/QmHASH
343344
* wrap://ens/sub.domain.eth
344-
* wrap://fs/directory/file.txt
345-
* wrap://uns/domain.crypto
345+
* wrap://file/directory/file.txt
346+
*
347+
* Some example short-hand URIs (utilizing inference):
348+
* ipfs/QmHASH -> wrap://ipfs/QmHASH
349+
* https://domain.com -> wrap://https/domain.com
350+
*
351+
* URI inference is performed in the following ways:
352+
* 1. If wrap:// is missing, it will be added.
353+
* 2. If non-wrap schema exists, it becomes the authority.
346354
*
347355
* Breaking down the various parts of the URI, as it applies
348356
* to [the URI standard](https://tools.ietf.org/html/rfc3986#section-3):
349357
* **wrap://** - URI Scheme: differentiates Polywrap URIs.
350-
* **ipfs/** - URI Authority: allows the Polywrap URI resolution algorithm to determine an authoritative URI resolver.
358+
* **ens/** - URI Authority: allows the Polywrap URI resolution algorithm to determine an authoritative URI resolver.
351359
* **sub.domain.eth** - URI Path: tells the Authority where the Wrapper resides.
352360
*/
353361
export class Uri {

0 commit comments

Comments
 (0)