Skip to content

Commit 5ed09a6

Browse files
committed
chore: update readme
1 parent d240ac0 commit 5ed09a6

File tree

2 files changed

+35
-6
lines changed

2 files changed

+35
-6
lines changed

packages/client/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,21 @@
1515
1616
# About
1717

18+
<!--
19+
20+
!IMPORTANT!
21+
22+
Everything in this README between "# About" and "# Install" is automatically
23+
generated and will be overwritten the next time the doc generator is run.
24+
25+
To make changes to this section, please update the @packageDocumentation section
26+
of src/index.js or src/index.ts
27+
28+
To experiment with formatting, please run "npm run docs" from the root of this
29+
repo and examine the changes made.
30+
31+
-->
32+
1833
A client implementation of the IPFS [Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) that can be used to interact with any compliant server implementation.
1934

2035
## Example

packages/server/README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,33 @@
1313

1414
> A Delegated Routing V1 HTTP API server powered by Helia
1515
16-
## About
16+
# About
17+
18+
<!--
19+
20+
!IMPORTANT!
21+
22+
Everything in this README between "# About" and "# Install" is automatically
23+
generated and will be overwritten the next time the doc generator is run.
24+
25+
To make changes to this section, please update the @packageDocumentation section
26+
of src/index.js or src/index.ts
27+
28+
To experiment with formatting, please run "npm run docs" from the root of this
29+
repo and examine the changes made.
30+
31+
-->
1732

1833
Implements HTTP routes for a Fastify server that conform to the [Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/).
1934

20-
### Example
35+
## Example
2136

2237
```typescript
2338
import { createHelia } from 'helia'
24-
import { createRoutingV1HttpApiServer } from '@helia/routing-v1-http-api-server'
39+
import { createDelegatedRoutingV1HttpApiServer } from '@helia/delegated-routing-v1-http-api-server'
2540

2641
const helia = await createHelia()
27-
const server = await createRoutingV1HttpApiServer(helia, {
42+
const server = await createDelegatedRoutingV1HttpApiServer(helia, {
2843
listen: {
2944
// fastify listen options
3045
}
@@ -34,9 +49,8 @@ const server = await createRoutingV1HttpApiServer(helia, {
3449
```
3550

3651
Alternatively if you have a Fastify instance already you can add routes to it.
37-
,
3852

39-
### Example
53+
## Example
4054

4155
```typescript
4256
import fastify from 'fastify'

0 commit comments

Comments
 (0)