Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
blouflashdb authored Jan 12, 2025
1 parent 01b35c4 commit 2ee174b
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@ A fully typed Nimiq RPC client for Nodejs and Deno.

### Installation
deno:

`deno add jsr:@blouflash/nimiq-rpc`

```
deno add jsr:@blouflash/nimiq-rpc
```
npm:

`npx jsr add @blouflash/nimiq-rpc`
```
npx jsr add @blouflash/nimiq-rpc
```

pnpm:

`pnpm dlx jsr add @blouflash/nimiq-rpc`
```
pnpm dlx jsr add @blouflash/nimiq-rpc
```

### Usage

Expand Down Expand Up @@ -77,7 +79,7 @@ subscribtion.close();

### Auth
Auth is not supported however you can use a proxy like nginx and pass the auth token via query url. I recommend to use tls.
```
```typescript
const client = new NimiqRPCClient("http://localhost/?token=mysecrettoken", "ws://localhost/ws?token=mysecrettoken");
```

Expand Down

0 comments on commit 2ee174b

Please sign in to comment.