From 9b3c1a619f43ebc172472e5a4dadb8194187b3e0 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Mon, 22 Oct 2018 14:12:14 +0200 Subject: [PATCH] docs: add Chromium-based Brave Brave announced first release of Chromium-based version: https://brave.com/new-brave-browser-release-available-for-general-download/ We document support for it and remove old docs about Muon-based Brave. --- README.md | 18 ++++++------------ docs/brave.md | 27 --------------------------- 2 files changed, 6 insertions(+), 39 deletions(-) delete mode 100644 docs/brave.md diff --git a/README.md b/README.md index e7612efa7..9ed269fc7 100644 --- a/README.md +++ b/README.md @@ -111,23 +111,23 @@ _(some are disabled by default, use Preferences screen to enable)_ We recommend installing the stable release via your browser's add-on store. -| Firefox | Chrome / Chromium | +| [Firefox](https://www.mozilla.org/firefox/new/) | [Chrome](https://www.google.com/chrome/) / [Chromium](https://www.chromium.org/Home) / [Brave](https://brave.com/) |------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [![Install From AMO](https://ipfs.io/ipfs/QmSX44XockQifmxE8Wdevkaa6vaqTXtGdH9t9aHWXZkuJq)](https://addons.mozilla.org/en-US/firefox/addon/ipfs-companion/) | [![Install from Chrome Store](https://ipfs.io/ipfs/QmPinSJKFYCMuTDh484dLk5Av4HpZRzBRR1KPv7TM7CBVF)](https://chrome.google.com/webstore/detail/ipfs-companion/nibjojkomfdiaoajekhjakgkdhaomnch) | +| [![Install From AMO](https://ipfs.io/ipfs/QmSX44XockQifmxE8Wdevkaa6vaqTXtGdH9t9aHWXZkuJq)](https://addons.mozilla.org/firefox/addon/ipfs-companion/) | [![Install from Chrome Store](https://ipfs.io/ipfs/QmPinSJKFYCMuTDh484dLk5Av4HpZRzBRR1KPv7TM7CBVF)](https://chrome.google.com/webstore/detail/ipfs-companion/nibjojkomfdiaoajekhjakgkdhaomnch) | **Note:** `ipfs-companion` is designed to retrieve content from a locally running IPFS daemon. -Make sure [IPFS is installed](https://ipfs.io/docs/getting-started/) on your computer. +Make sure [IPFS is installed](https://docs.ipfs.io/introduction/usage/) on your computer. ### Beta Channel Developers and enthusiasts can opt-in for Beta-quality channel with hand-picked Dev Builds: - Beta for Firefox: [Self-hosted Signed Dev Build](https://ipfs.io/ipfs/QmR8W5wg8BuAyBTruHnHovfWRavwvidVh3qtyinXi6NnLa) -- Beta for Chrome: [Dev Build at Chrome Web Store](https://chrome.google.com/webstore/detail/ipfs-companion-dev-build/hjoieblefckbooibpepigmacodalfndh) +- Beta for Chromium-based browsers: [Dev Build at Chrome Web Store](https://chrome.google.com/webstore/detail/ipfs-companion-dev-build/hjoieblefckbooibpepigmacodalfndh) It is also possible to [grab the last successful build from `master`](https://ci.ipfs.team/job/IPFS%20Shipyard/job/ipfs-companion/job/master/lastSuccessfulBuild/), but these builds are not signed nor will automatically update: -`.zip` bundles are meant only to be manually loaded via `chrome://extensions` (Chrome) or `about:debugging` (Firefox) for the purpose of quick smoke-testing. +`.zip` bundles are meant only to be manually loaded via `chrome://extensions` (Chromium-based) or `about:debugging` (Firefox) for the purpose of quick smoke-testing. ## Development @@ -138,7 +138,7 @@ To work on the extension you need to install it from source rather than from the ```bash npm install npm run build - npm run bundle:generic # for Chrome dev + npm run bundle:generic # for Chromium-based dev # or npm run bundle:firefox # for Firefox dev (build default) ``` @@ -180,12 +180,6 @@ Legacy versions `1.x.x` were based on currently deprecated Add-On SDK (Firefox- While it is not maintained anymore, one can inspect, build and install it using codebase from [legacy-sdk](https://github.com/ipfs/ipfs-companion/tree/legacy-sdk) branch. For historical background on the rewrite see [Issue #20: Move to WebExtensions](https://github.com/ipfs/ipfs-companion/issues/20). - -### Brave - -See [`docs/brave.md`](docs/brave.md) - - ## Contribute [![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](CONTRIBUTING.md) diff --git a/docs/brave.md b/docs/brave.md deleted file mode 100644 index 07f17a4a9..000000000 --- a/docs/brave.md +++ /dev/null @@ -1,27 +0,0 @@ -# IPFS Companion in Brave - -## 🚧 Current Status - -Developer version of `ipfs-companion` works in [Brave](https://brave.com/). -To try it out today you need to run Brave from source. -We are working with Brave to get seamless IPFS support working out of the box (with embedded [`js-ipfs`](https://github.com/ipfs/js-ipfs) node). - -Our progress can be tracked in [#312](https://github.com/ipfs/ipfs-companion/issues/312) 🏗️ - -## 👷 Developer Instructions for Running `HEAD` in Brave - -1. Configure your local ipfs gateway to run on port 9090 (_the default, port 8080, conflicts with the brave webpack dev server_) -1. Clone and build `ipfs-companion` as in [`README`](../README.md#build-from-sources) -1. Clone [`brave/browser-laptop`](https://github.com/brave/browser-laptop) -1. Symlink the `ipfs-companion/add-on` dir to `browser-laptop/app/extensions/ipfs` -1. Add the following to [`browser-laptop/app/extensions.js#L500-L502`](https://github.com/ipfs-shipyard/browser-laptop/blob/66f38870fced0dbc55aae7fe1ed905bff602f88e/app/extensions.js#L500-L502) - ```js - // Enable IPFS - extensionInfo.setState('ipfs', extensionStates.REGISTERED) - loadExtension('ipfs', getExtensionsPath('ipfs'), undefined, 'component') - ``` -1. In the `browser-laptop` project run `npm install` then in separate shells run `npm run watch` and `npm start`. If you have any trouble running Brave from source, check: https://github.com/brave/browser-laptop#installation -1. Brave will start up and you should see a badge with your number of connected ipfs peers next to the brave button, top right. - (If it does not, make sure these patches are merged: [issue](https://github.com/brave/browser-laptop/issues/11797), [pr](https://github.com/brave/browser-laptop/pull/11143)) -1. Click on the badge and update your gateway settings to use port `9090`, then go share something with your peers: - ![brave ipfs](https://user-images.githubusercontent.com/58871/34110877-e3080b0a-e3ff-11e7-8667-72fcef369386.gif)