Skip to content

Commit 701b92b

Browse files
whizzzkidElPaisano
andauthored
Add references to helia.io & address old js-ipfs stuff. (#1694)
Signed-off-by: Nishant Arora <[email protected]> Co-authored-by: ElPaisano <[email protected]>
1 parent 6fa0b66 commit 701b92b

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/reference/js/api.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,21 @@ description: Developer resources for working in JavaScript with IPFS, the InterP
55

66
# IPFS in JavaScript
77

8-
Developers can get started with IPFS in JavaScript using Helia, a lean, modular, and modern implementation of IPFS for the JS and browser environments. Helia superseded [js-ipfs](https://github.com/ipfs/js-ipfs), which was the first JS implementation. Learn more at [https://github.com/ipfs/helia](https://github.com/ipfs/helia).
8+
Developers can get started with IPFS in JavaScript (JS) using several options:
99

10-
## Hands-on examples
10+
- [IPFS Helia](https://helia.io): a lean, modular, and modern implementation of IPFS for the JS and browser environment
11+
- [js-kubo-rpc-client](https://github.com/ipfs/js-kubo-rpc-client): A JS client library for the [Kubo RPC API](../kubo/rpc.md)
1112

12-
New to IPFS or JavaScript? Get started with the [Helia 101 example](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-101), which will walk you through spawning a Helia node, adding a file, and `cat`-ing the file CID both locally and through an IPFS gateway.
13+
## Get started
1314

14-
Additional Helia examples can be found [here](https://github.com/ipfs-examples/helia-examples/tree/main).
15+
### Helia
16+
17+
New to IPFS Helia? The [Helia 101 example](https://github.com/ipfs-examples/helia-examples/tree/main/examples/helia-101) will walk you through spawning a Helia node, adding a file, and `cat`-ing the file CID both locally and through an IPFS gateway. More advanced Helia examples can be found [here](https://github.com/ipfs-examples/helia-examples/tree/main).
18+
19+
### js-kubo-rpc-client
20+
21+
To get started with the js-kubo-rpc-client, do the following:
22+
23+
1. Ensure that you have [kubo](https://github.com/ipfs/kubo) running. Since we're working with Node.js, you can [install kubo using npm](https://www.npmjs.com/package/kubo).
24+
1. Next, [install the client using `npm`, or load it as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install).
25+
1. Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information.

0 commit comments

Comments
 (0)