Skip to content

Commit dc78383

Browse files
authored
docs: clarify ipfs-http-client is for rpc (#3986)
Folks often mention it took them a moment to realize "HTTP Client" is for RPC API at `/api/v0/` and not HTTP Gateway or something else.
1 parent b5e8a88 commit dc78383

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<a href="https://ipfs.io"><img width="650px" src="https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse" alt="IPFS http client lib logo" /></a>
33
</h1>
44

5-
<h3 align="center">The JavaScript HTTP client library for IPFS implementations.</h3>
5+
<h3 align="center">The JavaScript HTTP RPC API client library for IPFS implementations.</h3>
66

77
<p align="center">
88
<a href="https://riot.im/app/#/room/#ipfs-dev:matrix.org"><img src="https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat" /> </a>
@@ -27,7 +27,7 @@
2727
<br>
2828
</p>
2929

30-
> A client library for the IPFS HTTP API, implemented in JavaScript. This client library implements the IPFS [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) enabling applications to change between an embedded js-ipfs node and any remote IPFS node without having to change the code. In addition, this client library implements a set of utility functions.
30+
> A client library for the IPFS HTTP RPC API (`/api/v0/*`), implemented in JavaScript. This client library implements the IPFS [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) enabling applications to change between an embedded js-ipfs node and any remote IPFS node without having to change the code. In addition, this client library implements a set of utility functions.
3131
3232
## Lead Maintainer <!-- omit in toc -->
3333

@@ -108,7 +108,7 @@ Alternatively it can be an object which may have the following keys:
108108

109109
| Name | Type | Default | Description |
110110
| ---- | ---- | ------- | ----------- |
111-
| url | `String` or `URL` or `Multiaddr` | `'http://localhost:5001/api/v0'` | A URL that resolves to a running instance of the IPFS HTTP API |
111+
| url | `String` or `URL` or `Multiaddr` | `'http://localhost:5001/api/v0'` | A URL that resolves to a running instance of the IPFS [HTTP RPC API](https://docs.ipfs.io/reference/http/api/) |
112112
| protocol | `String` | `'http'` | The protocol to used (ignored if url is specified) |
113113
| host | `String` | `'localhost'` | The host to used (ignored if url is specified) |
114114
| port | `number` | `5001` | The port to used (ignored if url is specified) |

0 commit comments

Comments
 (0)