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

chore: update docs/core-api/README #4159

Merged
merged 1 commit into from
Jul 21, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/core-api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# IPFS Core API

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.
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.
This abstraction allows for different implementations including:
1. Full JavaScript native implementation
2. Delgate implementation that invokes another IPFS implementation (e.g., Kubo)

You can use this loose spec as documentation for consuming the core APIs.

It is broken up into the following sections:

Expand All @@ -21,3 +26,6 @@ It is broken up into the following sections:
* [REPO.md](REPO.md)
* [STATS.md](STATS.md)
* [SWARM.md](SWARM.md)

## History
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.