Skip to content

Commit 3caa1eb

Browse files
authored
docs: add pin API doc links (ipfs#1524)
License: MIT Signed-off-by: Alan Shaw <[email protected]>
1 parent d338f6a commit 3caa1eb

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ The IPFS core API provides all functionality that is not specific to setting up
470470

471471
The core API is grouped into several areas:
472472

473-
#### `Files`
473+
#### Files
474474

475475
- [files](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md)
476476
- [`ipfs.files.add(data, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#filesadd). Alias to `ipfs.add`.
@@ -503,7 +503,7 @@ The core API is grouped into several areas:
503503
- [`ipfs.block.put(block, cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#put)
504504
- [`ipfs.block.stat(cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/BLOCK.md#stat)
505505

506-
#### `Graph`
506+
#### Graph
507507

508508
- [dag](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md)
509509
- [`ipfs.dag.put(dagNode, options, callback)`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/DAG.md#dagput)
@@ -521,9 +521,13 @@ The core API is grouped into several areas:
521521
- [`ipfs.object.patch.rmLink(multihash, DAGLink, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchrmlink)
522522
- [`ipfs.object.patch.appendData(multihash, data, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchappenddata)
523523
- [`ipfs.object.patch.setData(multihash, data, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/OBJECT.md#objectpatchsetdata)
524-
- [pin (not implemented, yet!)](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/)
525524

526-
#### `Crypto and Key Management`
525+
- [pin](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md)
526+
- [`ipfs.pin.add(hash, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md#pinadd)
527+
- [`ipfs.pin.ls([hash], [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md#pinls)
528+
- [`ipfs.pin.rm(hash, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/PIN.md#pinrm)
529+
530+
#### Crypto and Key Management
527531

528532
- [key](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/KEY.md)
529533
- `ipfs.key.export(name, password, [callback])`
@@ -534,7 +538,7 @@ The core API is grouped into several areas:
534538
- `ipfs.key.rm(name, [callback])`
535539
- [crypto (not yet implemented)](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC)
536540

537-
#### `Network`
541+
#### Network
538542

539543
- [bootstrap](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/)
540544
- `ipfs.bootstrap.list`
@@ -566,7 +570,7 @@ The core API is grouped into several areas:
566570
- [`ipfs.swarm.disconnect(addr, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#disconnect)
567571
- [`ipfs.swarm.peers([opts] [, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/SWARM.md#peers)
568572

569-
#### `Node Management`
573+
#### Node Management
570574

571575
- [miscellaneous operations](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md)
572576
- [`ipfs.id([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/MISCELLANEOUS.md#id)
@@ -595,7 +599,7 @@ The core API is grouped into several areas:
595599
- [`ipfs.config.set(key, value, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configset)
596600
- [`ipfs.config.replace(config, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC/CONFIG.md#configreplace)
597601

598-
#### `Domain data types`
602+
#### Domain data types
599603

600604
A set of data types are exposed directly from the IPFS instance under `ipfs.types`. That way you're not required to import/require the following.
601605
@@ -609,7 +613,7 @@ A set of data types are exposed directly from the IPFS instance under `ipfs.type
609613
- [`ipfs.types.dagPB`](https://github.com/ipld/js-ipld-dag-pb)
610614
- [`ipfs.types.dagCBOR`](https://github.com/ipld/js-ipld-dag-cbor)
611615
612-
#### `Util`
616+
#### Util
613617
614618
A set of utils are exposed directly from the IPFS instance under `ipfs.util`. That way you're not required to import/require the following:
615619

0 commit comments

Comments
 (0)