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

Commit bf23a4f

Browse files
authored
Merge pull request #587 from ipfs/feat/edit-readme
Small README edits
2 parents 16c2fa6 + 93f9998 commit bf23a4f

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,25 @@ Consult the [Roadmap](/ROADMAP.md) for a complete state description of the proje
3535
- [Use in the browser with browserify, webpack or any bundler](#use-in-the-browser-with-browserify-webpack-or-any-bundler)
3636
- [Use in a browser using a script tag](#use-in-a-browser-using-a-script-tag)
3737
- [Usage](#usage)
38-
- [Examples](#examples)
38+
- [CLI](#cli)
39+
- [HTTP-API](#http-api)
40+
- [IPFS Core examples (use IPFS as a module)](#ipfs-core-examples-use-ipfs-as-a-module)
41+
- [Create a IPFS node instance](#create-a-ipfs-node-instance)
42+
- [More to come](#more-to-come)
3943
- [API](#api)
44+
- [Generic API](#generic-api)
45+
- [Block API](#block-api)
46+
- [Object API](#object-api)
47+
- [Config API](#config-api)
48+
- [Files API](#files-api)
49+
- [Swarm API](#swarm-api)
50+
- [libp2p API](#libp2p-api)
4051
- [Development](#development)
41-
- [Project Architecture](/ARCHITECTURE.md)
52+
- [Clone](#clone)
53+
- [Install Dependencies](#install-dependencies)
54+
- [Run Tests](#run-tests)
55+
- [Lint](#lint)
56+
- [Build a dist version](#build-a-dist-version)
4257
- [Packages](#packages)
4358
- [Contribute](#contribute)
4459
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
@@ -166,7 +181,7 @@ node.init({ emptyRepo: true, bits: 2048 }, (err) => {
166181
167182
[![](https://github.com/ipfs/interface-ipfs-core/raw/master/img/badge.png)](https://github.com/ipfs/interface-ipfs-core)
168183
169-
A complete API definition will come, meanwhile, you can learn how to you use js-ipfs throught he standard interface at [![](https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg)](https://github.com/ipfs/interface-ipfs-core).
184+
A complete API definition is in the works. Meanwhile, you can learn how to you use js-ipfs through the standard interface at [![](https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg)](https://github.com/ipfs/interface-ipfs-core).
170185
171186
##### [Generic API](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic)
172187

0 commit comments

Comments
 (0)