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

Commit a92976e

Browse files
committed
docs: move docs around
1 parent b7b24b8 commit a92976e

File tree

4 files changed

+41
-160
lines changed

4 files changed

+41
-160
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ We've come a long way, but this project is still in Alpha, lots of development i
4747

4848
## Table of Contents <!-- omit in toc -->
4949

50+
- [Documentation](#documentation)
5051
- [Structure](#structure)
5152
- [Development](#development)
5253
- [Clone and install dependencies](#clone-and-install-dependencies)
@@ -59,6 +60,11 @@ We've come a long way, but this project is still in Alpha, lots of development i
5960
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
6061
- [License](#license)
6162

63+
## Documentation
64+
65+
* [API docs](./docs/api.md)
66+
* [Examples](./examples)
67+
6268
## Structure
6369

6470
This project is broken into several modules, their purposes are:

docs/API.md

Lines changed: 0 additions & 157 deletions
This file was deleted.

docs/CORE-API.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Core API
2+
3+
The Core API defines the set of operations that are possible to do with an IPFS node.
4+
5+
It is broken up into the following sections:
6+
7+
* [BITSWAP.md](api/BITSWAP.md)
8+
* [BLOCK.md](api/BLOCK.md)
9+
* [BOOTSTRAP.md](api/BOOTSTRAP.md)
10+
* [CONFIG.md]([api/CONFIG.md)
11+
* [DAG.md](api/DAG.md)
12+
* [DHT.md](api/DHT.md)
13+
* [FILES.md](api/FILES.md)
14+
* [KEY.md](api/KEY.md)
15+
* [MISCELLANEOUS.md](api/MISCELLANEOUS.md)
16+
* [NAME.md](api/NAME.md)
17+
* [OBJECT.md](api/OBJECT.md)
18+
* [PIN.md](api/PIN.md)
19+
* [PUBSUB.md](api/PUBSUB.md)
20+
* [REFS.md](api/REFS.md)
21+
* [STATS.md](api/STATS.md)
22+
* [SWARM.md](api/SWARM.md)

docs/README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
# IPFS Docs <!-- omit in toc -->
22

3-
- [How to use IPFS](#how-to-use-ipfs)
3+
- [API Docs](#api-docs)
4+
- [How tos and other documentation](#how-tos-and-other-documentation)
45
- [Development documentation](#development-documentation)
56

6-
## How to use IPFS
7+
## API Docs
8+
9+
`ipfs` can run as part of your program (an in-process node) or as a standalone daemon process that can be communicated with via an HTTP RPC API using the [`ipfs-http-client`](../packages/ipfs-http-api) module.
10+
11+
Whether accessed directly or over HTTP, both methods support the full [Core API](#core-api). In addition other methods are available to construct instances of each module, etc.
12+
13+
* [Core API docs](./API.md)
14+
* [IPFS API]('./IPFS.md)
15+
* [IPFS-HTTP-CLIENT API]('./IPFS-HTTP-CLIENT.md)
16+
17+
## How tos and other documentation
718

8-
* [API docs](./API.md)
919
* [How to run js-IPFS in the browser](./BROWSERS.md)
1020
* [js-IPFS configuration options](./CONFIG.md)
1121

0 commit comments

Comments
 (0)