Permalink
Browse files

README updates for v2.2.0

  • Loading branch information...
lidel committed Apr 9, 2018
1 parent d8a832c commit 2ecbaab5d8e54065979df59e1f803f7bc73bc183
Showing with 23 additions and 4 deletions.
  1. +23 −4 README.md
@@ -1,6 +1,6 @@
# IPFS Companion

![demo of v2.0.13](https://ipfs.io/ipfs/QmUxZrrjUGZVMjqc2noCRkQZr8B9JyGNj7sPpRoJ6uPQq1)
![demo of v2.2.0](https://user-images.githubusercontent.com/157609/38491868-6c9dbaa0-3bed-11e8-975a-52bea908f1cb.gif)

[![](https://img.shields.io/github/release/ipfs/ipfs-companion.svg)](https://github.com/ipfs/ipfs-companion/releases/latest)
[![](https://img.shields.io/badge/mozilla-reviewed-blue.svg)](https://addons.mozilla.org/en-US/firefox/addon/ipfs-companion/)
@@ -34,12 +34,27 @@ Learn more at [ipfs.io](https://ipfs.io) (it is really cool, we promise!)

#### Automagical Detection of IPFS Resources

Requests for resources at IPFS-like paths (`/ipfs/$cid` or `/ipns/$peerid_or_fqdn`) are detected on any website.
Requests for IPFS-like paths (`/ipfs/$cid` or `/ipns/$peerid_or_fqdn-with-dnslink`) are detected on any website.
If tested path is a valid IPFS address it gets redirected and loaded from a local gateway, e.g:
`https://ipfs.io/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR`
`http://127.0.0.1:8080/ipfs/QmbWqxBEKC3P8tqsKc98xmWNzrzDtRLMiMPL8wBuTGsMnR`

#### IPFS Status and Action Menu
#### IPFS API exposed as `window.ipfs`

A safe subset of IPFS APIs of user's node is exposed as `window.ipfs` on every webpage.
This means websites can detect if `window.ipfs` exists and opt-in to use it instead of spawning own `js-ipfs` node. This saves resources, battery etc.
Make sure to read our [notes on `window.ipfs`](https://github.com/ipfs-shipyard/ipfs-companion/blob/master/docs/window.ipfs.md), where we explain it in-depth and provide examples on how to use it your own dapp.

#### Embedded `js-ipfs` Node

Browser Action menu provides a toggle for switching between embedded, in-memory `js-ipfs` and external IPFS node accessed over HTTP API.

Embedded node is a fine fallback for situations when user needs to quickly share a file with someone or just wants to run a dapp against `window.ipfs` but has no third party IPFS daemon running locally.
Power users can provide own config (eg. to enable experimental pubsub) via _Preferences_.

**UX Note:** Embedded node does not run when external one is used. Every time you switch back to Embedded node, a new instance is spawned on-demand, so it takes [a few seconds](https://user-images.githubusercontent.com/157609/38493690-4a77bd9e-3bf3-11e8-85da-ba06fd94cdbf.gif) for a brand-new node to find peers.

#### IPFS Status and Context Actions

- IPFS API and Gateway status
- Quick Upload of local files
@@ -63,7 +78,6 @@ _(some are disabled by default, use Preferences screen to enable)_
- Make plaintext IPFS links clickable
- Mirror to IPFS by right click on any image or video
- Embedded node can be used for uploads even when external API is down
- [`window.ipfs`](docs/window.ipfs.md) - web pages can access your IPFS node

## Install

@@ -155,10 +169,15 @@ Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/ipfs-

If you want to help in developing this extension, please see [CONTRIBUTING](CONTRIBUTING.md) page :sparkles:

Browser extension team hangs out at the [#ipfs-in-web-browsers](https://webchat.freenode.net/?channels=ipfs-in-web-browsers) channel on Freenode.

This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

### TROUBLESHOOTING

The best place to ask your questions about IPFS in general, how it works and what you can do with it is at [discuss.ipfs.io](https://discuss.ipfs.io/).
We are also available at the [#ipfs](https://webchat.freenode.net/?channels=ipfs) channel, where most of IPFS community hangs out.

#### Upload via Right-Click Does Not Work in Firefox

See [this workaround](https://github.com/ipfs/ipfs-companion/issues/227).

0 comments on commit 2ecbaab

Please sign in to comment.