Skip to content

Commit

Permalink
Objectives and Key Results for Q1 2018 [Draft]
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Dec 3, 2017
1 parent 6b4789f commit 27998ec
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ See the [ROADMAP](ROADMAP.md#the-path-to-adoption) for a breakdown of the steps

## Current Status

Currently in order to run IPFS in a web browser, you have to either bundle js-ipfs with your client-side application or your users have to run a go-ipfs daemon on their local machines. This means we've completed the first step on [The Path to Native Browser Support](ROADMAP.md#the-path-to-native-browser-support).
Currently in order to run IPFS in a web browser, you have to either bundle [js-ipfs](https://github.com/ipfs/js-ipfs) with your client-side application
or your users have to run a [browser extension](https://github.com/ipfs/ipfs-companion/)
and [go-ipfs](https://github.com/ipfs/go-ipfs) daemon on their local machines.

The [Sprint 13-24 February](https://github.com/ipfs/pm/issues/351) is aimed at tackling a number of the next steps.
8 changes: 7 additions & 1 deletion ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Roadmap: IPFS In Web Browsers
======

_**THIS IS A WORK IN PROGRESS** We are actively working on this Roadmap. It is subject to major changes durring the current 2-week sprint. See [ipfs/in-web-browsers#23](https://github.com/ipfs/in-web-browsers/issues/23) to track the work or comment on it._
_**THIS IS A WORK IN PROGRESS** We are actively working on this Roadmap._

_See [ipfs/in-web-browsers#23](https://github.com/ipfs/in-web-browsers/issues/23) to track the work or comment on it._

**What we want:** Protocol handlers for decentralized web protocols, especially IPFS and IPLD, bundled natively in web browsers.

Expand All @@ -15,3 +17,7 @@ _**THIS IS A WORK IN PROGRESS** We are actively working on this Roadmap. It is s
* **Step 4.** *[IN PROGRESS](https://github.com/ipfs/in-web-browsers/milestone/1)* Create browsers add-ons and/or extensions that handle dweb protocols see [Epic: Web Extension supports gateways and core api with both js and go nodes](https://github.com/ipfs/in-web-browsers/issues/39) and the list of [web extension issues](https://github.com/ipfs/in-web-browsers/labels/web%20extension))
* **Step 5.** *NEXT STEP* Make the case for IPFS & Decentralized Web Protocols in Web Browsers with Use Cases, Sample Applications, Demos and Delightful Documentation
* **Step 6.** Native support in the Browsers: Protocol Handlers incorporated into the browsers by default

## Quarterly Objectives and Key Results

* [2018 Q1](objectives-and-key-results/OKR-2018-Q1.md)
43 changes: 43 additions & 0 deletions objectives-and-key-results/OKR-2018-Q1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Objectives and Key Results for Q1 2018

Quarterly statement of OKRs (Objectives and Key Results) for the "IPFS in Web Browsers" effort.

## OKR-2018-Q1-1

#### Objective

- **[IPFS Companion](https://github.com/ipfs/ipfs-companion) is a solid foundation for browser integration(s) going forward**

#### Key Results

- Single codebase is running on all browsers (no forks, browser-specific modules are used instead)
- QA practices are established, test coverage at 80%+ ([ipfs-companion/#145](https://github.com/ipfs/ipfs-companion/issues/145))
- Up-to-date developer documentation exists

## OKR-2018-Q1-2

#### Objective

- **Improved initial experience for non-technical users of mainstream browsers**

#### Key Results

- Continuous presence in browser extension stores (pass/address reviews on time)
- Catering to less-technical users of Firefox or Chrome
- Simplified UI
- Display user-focused primer on distributed web after initial install ([ipfs-companion/#324](https://github.com/ipfs/ipfs-companion/issues/324))
- UX without local go-ipfs node is improved (eg. embedded js-ipfs is used for uploads, public gateway for downloads)

## OKR-2018-Q1-3

#### Objective

- **[Brave](https://brave.com) is the first browser with "native" IPFS support**

#### Key Results

- IPFS connectivity working out-of-the-box in Brave
- Embedded js-ipfs runs in Brave without installing external daemon
- User experience is the same as in Firefox when running external node
- Support for native protocols in Location Bar and DOM elements (`href`, `src`)

0 comments on commit 27998ec

Please sign in to comment.