Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme examples to be esm #55

Merged
merged 1 commit into from
Sep 21, 2022
Merged

docs: update readme examples to be esm #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,6 @@
$ npm i is-ipfs
```

## Lead Maintainer

[Marcin Rataj](https://github.com/lidel)

```bash
$ npm install --save is-ipfs
```
Expand All @@ -56,7 +52,7 @@ $ npm install --save is-ipfs
The code published to npm that gets loaded on require is in fact an ES5 transpiled version with the right shims added. This means that you can require it and use with your favorite bundler without having to adjust asset management process.

```js
const isIPFS from 'is-ipfs')
import * as isIPFS from 'is-ipfs'
```

### In the Browser through `<script>` tag
Expand All @@ -72,7 +68,7 @@ Loading this module through a script tag will make the `IsIpfs` obj available in
# Usage

```javascript
const isIPFS from 'is-ipfs')
import * as isIPFS from 'is-ipfs'

isIPFS.multihash('QmYjtig7VJQ6XsnUjqqJvj7QaMcCAwtrgNdahSiFofrE7o') // true
isIPFS.multihash('noop') // false
Expand Down