Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Commit cfc390a

Browse files
authored
reorg (#161)
1 parent 49a135a commit cfc390a

File tree

14 files changed

+61
-58
lines changed

14 files changed

+61
-58
lines changed

README.md

Lines changed: 60 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
- [Badge](#badge)
1515
- [Install](#install)
1616
- [Usage](#usage)
17-
- [Node.js](#nodejs)
17+
- [JavaScript](#nodejs)
1818
- [Go](#go)
1919
- [API](#api)
2020
- [Contribute](#contribute)
@@ -29,16 +29,15 @@ The API is presented with both Node.js and Go primitives. However, there are no
2929

3030
### Modules that implement the interface
3131

32-
- **WIP** [JavaScript IPFS implementation](https://github.com/ipfs/js-ipfs)
33-
- **WIP** [JavaScript ipfs-api](https://github.com/ipfs/js-ipfs-api)
32+
- [JavaScript IPFS implementation](https://github.com/ipfs/js-ipfs)
33+
- [JavaScript IPFS HTTP Client Library](https://github.com/ipfs/js-ipfs-api)
3434
- Soon™, go-ipfs, go-ipfs-api, java-ipfs-api, python-ipfs-api and others will implement it as well.
3535

3636
Send in a PR if you find or write one!
3737

3838
### Badge
3939

40-
Include this badge in your readme if you make a new module that implements
41-
interface-ipfs-core API.
40+
Include this badge in your readme if you make a new module that implements interface-ipfs-core API.
4241

4342
![](/img/badge.png)
4443

@@ -57,7 +56,7 @@ In Go land:
5756

5857
## Usage
5958

60-
### Node.js
59+
### JavaScript
6160

6261
Install `interface-ipfs-core` as one of the dependencies of your project and as a test file. Then, using `mocha` (for Node.js) or a test runner with compatible API, do:
6362

@@ -85,57 +84,61 @@ test.all(common)
8584

8685
In order to be considered "valid", an IPFS core implementation must expose the API described in [/API](/API). You can also use this loose spec as documentation for consuming the core APIs. Here is an outline of the contents of that directory:
8786

88-
- [bitswap (not spec'ed yet)](/API/bitswap)
89-
- [block](/API/block)
90-
- [`block.get`](/API/block#get)
91-
- [`block.put`](/API/block#put)
92-
- [`block.stat`](/API/block#stat)
93-
- [bootstrap](/API/bootstrap)
94-
- [config](/API/config)
95-
- [`config.get`](/API/config#get)
96-
- [`config.set`](/API/config#set)
97-
- [`config.replace`](/API/config#replace)
98-
- [dag](/API/dag)
99-
- [`dag.put`](/API/dag#dagput)
100-
- [`dag.get`](/API/dag#dagget)
101-
- [`dag.tree`](/API/dag#dagtree)
102-
- [dht (not spec'ed yet)](/API/dht)
103-
- [files](/API/files)
104-
- [`add`](/API/files#add)
105-
- [`createAddStream`](/API/files#createaddstream)
106-
- [`get`](/API/files#get)
107-
- [`cat`](/API/files#cat)
108-
- [generic operations](/API/generic)
109-
- [`id`](/API/generic#id)
110-
- [`version`](/API/generic#version)
111-
- [object](/API/object)
112-
- [`object.new`](/API/object#objectnew)
113-
- [`object.put`](/API/object#objectput)
114-
- [`object.get`](/API/object#objectget)
115-
- [`object.data`](/API/object#objectdata)
116-
- [`object.links`](/API/object#objectlinks)
117-
- [`object.stat`](/API/object#objectstat)
118-
- [`object.patch`](/API/object#objectpatch)
119-
- [`object.patch.addLink`](/API/object#objectpatchaddlink)
120-
- [`object.patch.rmLink`](/API/object#objectpatchrmlink)
121-
- [`object.patch.appendData`](/API/object#objectpatchappenddata)
122-
- [`object.patch.setData`](/API/object#objectpatchsetdata)
123-
- [pin](/API/pin)
124-
- [`pin.add`](/API/pin#add)
125-
- [`pin.ls`](/API/pin#ls)
126-
- [`pin.rm`](/API/pin#rm)
127-
- [pubsub](/API/pubsub)
128-
- [`pubsub.subscribe`](/API/pubsub#pubsubsubscribe)
129-
- [`pubsub.unsubscribe`](/API/pubsub#pubsubunsubscribe)
130-
- [`pubsub.publish`](/API/pubsub#pubsubpublish)
131-
- [`pubsub.ls`](/API/pubsub#pubsubls)
132-
- [`pubsub.peers`](/API/pubsub#pubsubpeers)
133-
- [repo (not spec'ed yet)](/API/repo)
134-
- [swarm](/API/swarm)
135-
- [`swarm.addrs`](/API/swarm#addrs)
136-
- [`swarm.connect`](/API/swarm#connect)
137-
- [`swarm.disconnect`](/API/swarm#disconnect)
138-
- [`swarm.peers`](/API/swarm#peers)
87+
- **Files**
88+
- [files](/API/files)
89+
- [`add`](/API/files#add)
90+
- [`createAddStream`](/API/files#createaddstream)
91+
- [`get`](/API/files#get)
92+
- [`cat`](/API/files#cat)
93+
- [repo (not spec'ed yet)](/API/repo)
94+
- [block](/API/block)
95+
- [`block.get`](/API/block#get)
96+
- [`block.put`](/API/block#put)
97+
- [`block.stat`](/API/block#stat)
98+
- **Graph**
99+
- [dag](/API/dag)
100+
- [`dag.put`](/API/dag#dagput)
101+
- [`dag.get`](/API/dag#dagget)
102+
- [`dag.tree`](/API/dag#dagtree)
103+
- [object](/API/object)
104+
- [`object.new`](/API/object#objectnew)
105+
- [`object.put`](/API/object#objectput)
106+
- [`object.get`](/API/object#objectget)
107+
- [`object.data`](/API/object#objectdata)
108+
- [`object.links`](/API/object#objectlinks)
109+
- [`object.stat`](/API/object#objectstat)
110+
- [`object.patch`](/API/object#objectpatch)
111+
- [`object.patch.addLink`](/API/object#objectpatchaddlink)
112+
- [`object.patch.rmLink`](/API/object#objectpatchrmlink)
113+
- [`object.patch.appendData`](/API/object#objectpatchappenddata)
114+
- [`object.patch.setData`](/API/object#objectpatchsetdata)
115+
- [pin](/API/pin)
116+
- [`pin.add`](/API/pin#add)
117+
- [`pin.ls`](/API/pin#ls)
118+
- [`pin.rm`](/API/pin#rm)
119+
- **Network**
120+
- [bootstrap](/API/bootstrap)
121+
- [bitswap (not spec'ed yet)](/API/bitswap)
122+
- [dht (not spec'ed yet)](/API/dht)
123+
- [pubsub](/API/pubsub)
124+
- [`pubsub.subscribe`](/API/pubsub#pubsubsubscribe)
125+
- [`pubsub.unsubscribe`](/API/pubsub#pubsubunsubscribe)
126+
- [`pubsub.publish`](/API/pubsub#pubsubpublish)
127+
- [`pubsub.ls`](/API/pubsub#pubsubls)
128+
- [`pubsub.peers`](/API/pubsub#pubsubpeers)
129+
- [swarm](/API/swarm)
130+
- [`swarm.addrs`](/API/swarm#addrs)
131+
- [`swarm.connect`](/API/swarm#connect)
132+
- [`swarm.disconnect`](/API/swarm#disconnect)
133+
- [`swarm.peers`](/API/swarm#peers)
134+
- **Node Management**
135+
- [Miscellabeous](/API/miscellaneous)
136+
- [`id`](/API/generic#id)
137+
- [`version`](/API/generic#version)
138+
- [config](/API/config)
139+
- [`config.get`](/API/config#get)
140+
- [`config.set`](/API/config#set)
141+
- [`config.replace`](/API/config#replace)
139142

140143
## Contribute
141144

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)