Skip to content

Commit

Permalink
js-kubo-rpc-client get started updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@ElPaisano
ElPaisano authored Sep 22, 2023
1 parent 1689263 commit 0f6c161
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/reference/js/api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,8 @@ New to IPFS Helia? The [Helia 101 example](https://github.com/ipfs-examples/heli

### js-kubo-rpc-client

First, make sure you have [kubo](https://github.com/ipfs/kubo) running, there are multiple ways to get [kubo](https://github.com/ipfs/kubo), since we're working with node, you can [get kubo using npm](https://www.npmjs.com/package/kubo). Next, [install the client using `npm` or as load it as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install). Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information.
To get started with the js-kubo-rpc-client, do the following:

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).

Check failure on line 23 in docs/reference/js/api.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/reference/js/api.md#L23 

[ipfs-docs-style.PLNSpelling] Did you really mean 'npm'?
Raw output 
{"message": "[ipfs-docs-style.PLNSpelling] Did you really mean 'npm'?", "location": {"path": "docs/reference/js/api.md", "range": {"start": {"line": 23, "column": 133}}}, "severity": "ERROR"}
1. Next, [install the client using `npm`, or load it as a browser script tag](https://github.com/ipfs/js-kubo-rpc-client#install).
1. Then, consult the [command reference](https://github.com/ipfs/js-kubo-rpc-client#usage) for usage information.

0 comments on commit 0f6c161

Please sign in to comment.