diff --git a/docs/extension.md b/docs/extension.md new file mode 100644 index 0000000..e018064 --- /dev/null +++ b/docs/extension.md @@ -0,0 +1,25 @@ +--- +title: Browser Extension +--- + +Lume has been put into a browser extension as the first prototype product being created. This is an **extremely** early demo and many things are buggy and can break. + +This extension has the goal of letting you browse decentralized (web3) websites, but doing so in an *actual* decentralized way. This means not using: + +* AWS/Cloud for blockchain access +* Cloudflare/CDN's for application access +* ICANN (.com, .net, .org) for your website name + +You will get your own Lume account that is a 12 word seed, which will create an anonymous account on web3portal.com. + +The current networks supported are: + +* Handshake (https://handshake.org) +* Ethereum (https://ethereum.org) +* IPFS (https://ipfs.io) +* Normal servers (accessing a VPS/Dedicated Server/Cloud server/Web host) + +The current domain networks supported are: + +* Handshake +* ENS diff --git a/docs/extension/account.md b/docs/extension/account.md new file mode 100644 index 0000000..f34ea89 --- /dev/null +++ b/docs/extension/account.md @@ -0,0 +1,7 @@ +--- +title: Account +--- + +After you have either gone through the onboarding or skipped it you will be greeted with a login. Lume uses a 12 word seed as an account, and you can either provide your own or have one be created. + +![Account](/extension/account.png) diff --git a/docs/extension/bootup.md b/docs/extension/bootup.md new file mode 100644 index 0000000..5236924 --- /dev/null +++ b/docs/extension/bootup.md @@ -0,0 +1,7 @@ +--- +title: Booting +--- + +Lume now has to connect into the network, this process is usually fast and should not take more than a minute. + +![Bootup](/extension/bootup.png) diff --git a/docs/extension/start.md b/docs/extension/start.md new file mode 100644 index 0000000..817584f --- /dev/null +++ b/docs/extension/start.md @@ -0,0 +1,9 @@ +--- +title: Start +--- + +The browser extension is currently Firefox only. Google has enforced security restrictions on Chrome/Chromium to make creating an all-in-one extension not feasible engineering-wise without compromising on decentralization. Simply put, Google's browser is more restrictive than any other. + +You will need to install the extension at https://addons.mozilla.org/en-US/firefox/addon/lume-web/ + +![Start](/extension/start.png) diff --git a/docs/extension/sync.md b/docs/extension/sync.md new file mode 100644 index 0000000..a1f53fe --- /dev/null +++ b/docs/extension/sync.md @@ -0,0 +1,13 @@ +--- +title: Sync +--- + +Once you are in the dashboard you will need to let all networks sync. This is the current estimated time of all networks syncing: + +* Handshake: 45 min +* Ethereum: 5 min +* IPFS: 1 min + +Once done you can now browse web3 (the open web) with Lume! + +![Start](/extension/sync.png) diff --git a/docs/extension/websites.md b/docs/extension/websites.md new file mode 100644 index 0000000..ad4618d --- /dev/null +++ b/docs/extension/websites.md @@ -0,0 +1,18 @@ +--- +title: Websites +--- + +There are a few things to note before you start browsing. As stated before, this is an early demo. So here are a list of known problems: + +* IPFS is highly hit/miss. It fails more often that it works and needs more love. IPNS which works with IPFS is generally even worse. +* Ethereum may have issues syncing. If this acts up or takes too long, try reloading the extension, re-installing the extension, or restarting Firefox. + +We have also mentioned that the extension is partially-centralized. Current it uses only one P2P node run by the project. + +Now below are some example sites to try out: + +* `mempooler` This is a normal server on Handshake +* `bafybeiguremy5hkphmhzqibnj4ftbursom5lhc52fxn3qaycj3kecy4ifi.ipfs.lume` This is a means of directly accessing an IPFS website +* `ens.eth` This one is highly likely to fail or just hang. Complex websites are not well-supported yet. + +Note that due to ENS users mostly relying on IPNS, many ETH sites will not work well or at all right now. diff --git a/static/extension/account.png b/static/extension/account.png new file mode 100644 index 0000000..24371bf Binary files /dev/null and b/static/extension/account.png differ diff --git a/static/extension/bootup.png b/static/extension/bootup.png new file mode 100644 index 0000000..a36f1d4 Binary files /dev/null and b/static/extension/bootup.png differ diff --git a/static/extension/start.png b/static/extension/start.png new file mode 100644 index 0000000..83c548f Binary files /dev/null and b/static/extension/start.png differ diff --git a/static/extension/sync.png b/static/extension/sync.png new file mode 100644 index 0000000..24371bf Binary files /dev/null and b/static/extension/sync.png differ