Skip to content

Commit

Permalink
docs: update readme (#77)
Browse files Browse the repository at this point in the history
Update readme with examples
  • Loading branch information
achingbrain authored Jan 6, 2022
1 parent 056c660 commit 6a23bb1
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@
## Install

```sh
npm install multiaddr-to-uri
npm install @multiformats/multiaddr-to-uri
```

## Usage

```js
const toUri = require('multiaddr-to-uri')
import { multiaddrToUri } from '@multiformats/multiaddr-to-uri'

console.log(toUri('/dnsaddr/protocol.ai/https'))
console.log(multiaddrToUri('/dnsaddr/protocol.ai/https'))
// -> https://protocol.ai

console.log(toUri('/ip4/127.0.0.1/tcp/8080'))
console.log(multiaddrToUri('/ip4/127.0.0.1/tcp/8080'))
// -> http://127.0.0.1:8080

console.log(toUri('/ip4/127.0.0.1/tcp/8080', { assumeHttp: false }))
console.log(multiaddrToUri('/ip4/127.0.0.1/tcp/8080', { assumeHttp: false }))
// -> tcp://127.0.0.1:8080
```

Expand Down

0 comments on commit 6a23bb1

Please sign in to comment.