Skip to content
This repository was archived by the owner on Mar 10, 2020. It is now read-only.

Fix browser instance instructions in README #265

Merged
merged 1 commit into from
May 7, 2016
Merged

Fix browser instance instructions in README #265

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,16 @@ You can use [npmcdn](https://npmcdn.com/) to get the latest built version, like
<script src="https://npmcdn.com/ipfs-api/dist/index.js"></script>
```

This will export the `ipfsAPI` constructor on the `window` object, such that:
This will export the `IpfsApi` constructor on the `window` object, such that:

```
var ipfs = window.ipfsAPI('localhost', '5001')
var ipfs = window.IpfsApi('localhost', '5001')
```

If you omit the host and port, the api will parse `window.host`, and use this information. This also works, and can be useful if you want to write apps that can be run from multiple different gateways:

```
var ipfs = window.ipfsAPI()
var ipfs = window.IpfsApi()
```

## CORS
Expand Down