Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 7a7e091

Browse files
authoredJul 21, 2022
chore: update docs/core-api/README (#4159)
1 parent 3b25957 commit 7a7e091

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed
 

‎docs/core-api/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# IPFS Core API
22

3-
This directory contains the description of the core IPFS API. In order to be considered "valid", an IPFS core implementation must expose the API described here. You can also use this loose spec as documentation for consuming the core APIs.
3+
This directory contains the description of the core JS IPFS API. In order to be considered "valid", a JS IPFS core implementation must expose the API described here.
4+
This abstraction allows for different implementations including:
5+
1. Full JavaScript native implementation
6+
2. Delgate implementation that invokes another IPFS implementation (e.g., Kubo)
7+
8+
You can use this loose spec as documentation for consuming the core APIs.
49

510
It is broken up into the following sections:
611

@@ -21,3 +26,6 @@ It is broken up into the following sections:
2126
* [REPO.md](REPO.md)
2227
* [STATS.md](STATS.md)
2328
* [SWARM.md](SWARM.md)
29+
30+
## History
31+
This API was created based off the [Kubo RPC HTTP API](https://docs.ipfs.io/reference/kubo/rpc/). There is no guarantee they stay fully in sync.

0 commit comments

Comments
 (0)
This repository has been archived.