Skip to content

Commit

Permalink
docs: update readme examples to import correct symbols (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
achingbrain authored Dec 3, 2023
1 parent e8d3243 commit bcfc785
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions packages/client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A client implementation of the IPFS [Delegated Routing V1 HTTP API](https://spec
## Example

```typescript
import { createDelegatedRoutingV1HttpApiClient } from '@helia/routing-v1-http-api-client'
import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { CID } from 'multiformats/cid'

const client = createDelegatedRoutingV1HttpApiClient('https://example.org')
Expand All @@ -35,7 +35,7 @@ The client can be configured as a libp2p service, this will enable it as both a
## Example

```typescript
import { createDelegatedRoutingV1HttpApiClient } from '@helia/routing-v1-http-api-client'
import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
import { createLibp2p } from 'libp2p'
import { peerIdFromString } from '@libp2p/peer-id'

Expand Down
4 changes: 2 additions & 2 deletions packages/client/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
* @example
*
* ```typescript
* import { createDelegatedRoutingV1HttpApiClient } from '@helia/routing-v1-http-api-client'
* import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
* import { CID } from 'multiformats/cid'
*
* const client = createDelegatedRoutingV1HttpApiClient('https://example.org')
Expand All @@ -23,7 +23,7 @@
* @example
*
* ```typescript
* import { createDelegatedRoutingV1HttpApiClient } from '@helia/routing-v1-http-api-client'
* import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
* import { createLibp2p } from 'libp2p'
* import { peerIdFromString } from '@libp2p/peer-id'
*
Expand Down
4 changes: 2 additions & 2 deletions packages/server/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
*
* ```typescript
* import { createHelia } from 'helia'
* import { createRoutingV1HttpApiServer } from '@helia/routing-v1-http-api-server'
* import { createDelegatedRoutingV1HttpApiServer } from '@helia/delegated-routing-v1-http-api-server'
*
* const helia = await createHelia()
* const server = await createRoutingV1HttpApiServer(helia, {
* const server = await createDelegatedRoutingV1HttpApiServer(helia, {
* listen: {
* // fastify listen options
* }
Expand Down

0 comments on commit bcfc785

Please sign in to comment.