docs: move docs around

ipfs · Mar 25, 2020 · a92976e · a92976e
1 parent b7b24b8
commit a92976e
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 160 deletions.
diff --git a/README.md b/README.md
@@ -47,6 +47,7 @@ We've come a long way, but this project is still in Alpha, lots of development i
 
 ## Table of Contents <!-- omit in toc -->
 
+- [Documentation](#documentation)
 - [Structure](#structure)
 - [Development](#development)
   - [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
   - [Want to hack on IPFS?](#want-to-hack-on-ipfs)
 - [License](#license)
 
+## Documentation
+
+* [API docs](./docs/api.md)
+* [Examples](./examples)
+
 ## Structure
 
 This project is broken into several modules, their purposes are:

diff --git a/docs/API.md b/docs/API.md
diff --git a/docs/CORE-API.md b/docs/CORE-API.md
@@ -0,0 +1,22 @@
+## Core API
+
+The Core API defines the set of operations that are possible to do with an IPFS node.
+
+It is broken up into the following sections:
+
+* [BITSWAP.md](api/BITSWAP.md)
+* [BLOCK.md](api/BLOCK.md)
+* [BOOTSTRAP.md](api/BOOTSTRAP.md)
+* [CONFIG.md]([api/CONFIG.md)
+* [DAG.md](api/DAG.md)
+* [DHT.md](api/DHT.md)
+* [FILES.md](api/FILES.md)
+* [KEY.md](api/KEY.md)
+* [MISCELLANEOUS.md](api/MISCELLANEOUS.md)
+* [NAME.md](api/NAME.md)
+* [OBJECT.md](api/OBJECT.md)
+* [PIN.md](api/PIN.md)
+* [PUBSUB.md](api/PUBSUB.md)
+* [REFS.md](api/REFS.md)
+* [STATS.md](api/STATS.md)
+* [SWARM.md](api/SWARM.md)
diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,21 @@
 # IPFS Docs <!-- omit in toc -->
 
-- [How to use IPFS](#how-to-use-ipfs)
+- [API Docs](#api-docs)
+- [How tos and other documentation](#how-tos-and-other-documentation)
 - [Development documentation](#development-documentation)
 
-## How to use IPFS
+## API Docs
+
+`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.
+
+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.
+
+* [Core API docs](./API.md)
+* [IPFS API]('./IPFS.md)
+* [IPFS-HTTP-CLIENT API]('./IPFS-HTTP-CLIENT.md)
+
+## How tos and other documentation
 
-* [API docs](./API.md)
 * [How to run js-IPFS in the browser](./BROWSERS.md)
 * [js-IPFS configuration options](./CONFIG.md)