Replace draft with full manual (docs-as-code, colors, logo, versioning)
Some checks failed
Build and deploy docs / deploy (push) Has been cancelled
Some checks failed
Build and deploy docs / deploy (push) Has been cancelled
This commit is contained in:
53
docs/getting-started/installation.md
Normal file
53
docs/getting-started/installation.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Installation
|
||||
|
||||
## Requirements
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| **Electrum** | {{ bal.electrum_latest }} (last stable release tested) |
|
||||
| **Platform** | Desktop — Linux, Windows, macOS |
|
||||
| **License** | MIT |
|
||||
| **Wallet type** | Standard seed-based single-signature, or a [hardware wallet](../user-guide/hardware-wallets.md). See [Compatibility](../user-guide/compatibility.md). |
|
||||
|
||||
Install Electrum first, from the official site [electrum.org](https://electrum.org), and verify its signature as you normally would.
|
||||
|
||||
## 1. Download the plugin
|
||||
|
||||
Get the latest release from the [plugin releases page](https://bitcoin-after.life/gitea/bitcoinafterlife/bal-electrum-plugin/releases).
|
||||
|
||||
!!! tip "Verify the archive"
|
||||
Check that the zip's SHA-256 matches the value printed by `build_zip.py`. If you built the zip yourself from source, compare it against the published release.
|
||||
|
||||
## 2. Install it in Electrum
|
||||
|
||||
{ .screenshot }
|
||||
*Electrum → Tools → Plugins.*
|
||||
|
||||
1. Open Electrum and go to **Tools → Plugins**.
|
||||
2. Choose **install from file** and select the BAL zip.
|
||||
|
||||
{ .screenshot }
|
||||
*Selecting the plugin archive.*
|
||||
|
||||
## 3. Enable and restart
|
||||
|
||||
Tick **Bitcoin After Life** in the plugin list, then restart Electrum.
|
||||
|
||||
{ .screenshot }
|
||||
*The plugin enabled and ready.*
|
||||
|
||||
## 4. Check that it loaded
|
||||
|
||||
After restarting you will see two new tabs in the Electrum window: **HEIRS** and **WILL**.
|
||||
|
||||
{ .screenshot }
|
||||
*HEIRS is where you define who inherits; WILL shows the technical state of your inheritance transactions.*
|
||||
|
||||
Next: [create your first will](quick-start.md).
|
||||
|
||||
## Platform-specific notes
|
||||
|
||||
Step-by-step installation notes for specific platforms are kept in their own repositories:
|
||||
|
||||
- [Windows installation](https://bitcoin-after.life/gitea/bitcoinafterlife/bal_plugin_windows_installation)
|
||||
- [Linux installation](https://bitcoin-after.life/gitea/bitcoinafterlife/bal_plugin_linux_installation)
|
||||
54
docs/getting-started/quick-start.md
Normal file
54
docs/getting-started/quick-start.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Create your first will
|
||||
|
||||
The plugin ships with a **guided wizard** that walks you through the whole setup. You only need two decisions: *who inherits* and *when*.
|
||||
|
||||
!!! tip "Do a dry run first"
|
||||
Set a delivery time a few hours away on a test wallet, and watch the transaction move through the states in the [WILL tab](../user-guide/will-tab.md). On such a short horizon, remember to disable or back-date [Check Alive](../user-guide/check-alive.md) so it doesn't interfere.
|
||||
|
||||
## Step 1 — Start the wizard
|
||||
|
||||
{ .screenshot }
|
||||
*The wizard walks through heirs, date, and Will-Executors in order.*
|
||||
|
||||
## Step 2 — Add your heirs
|
||||
|
||||
Enter the Bitcoin address of each heir and the share of the wallet they receive — as a percentage or as a fixed amount.
|
||||
|
||||
{ .screenshot }
|
||||
*One row per heir. You can add as many as you need.*
|
||||
|
||||
The plugin always distributes **100%** of the wallet. If your shares don't add up, it recalculates them proportionally — see [Heirs and shares](../user-guide/heirs.md#the-wallet-is-always-emptied-to-100).
|
||||
|
||||
## Step 3 — Choose the delivery time
|
||||
|
||||
This is the date on which the Will-Executors broadcast the inheritance to the Bitcoin network.
|
||||
|
||||
{ .screenshot }
|
||||
*You can pick a date from the calendar or express it as a relative delay.*
|
||||
|
||||
See [Delivery time](../user-guide/delivery-time.md) for how relative values and execution tolerance work.
|
||||
|
||||
## Step 4 — Select the Will-Executors
|
||||
|
||||
The plugin downloads the [WeList](../will-executors/welist.md) directory and shows the available servers with their fees.
|
||||
|
||||
{ .screenshot }
|
||||
*Select as many as you can: one transaction is created per Will-Executor.*
|
||||
|
||||
!!! info "Pick many, not few"
|
||||
Each selected Will-Executor gets its own copy of the inheritance, with its own fee output. For the inheritance to succeed, **only one of them** has to still be operating on the delivery date. More servers means more redundancy.
|
||||
|
||||
## Step 5 — Review and sign
|
||||
|
||||
{ .screenshot }
|
||||
*Review everything before signing.*
|
||||
|
||||
Electrum then asks for your wallet password — or confirmation on your hardware wallet — and signs the transactions. The plugin never signs for you.
|
||||
|
||||
Once signed, the wills are sent to the selected Will-Executors and appear in the [WILL tab](../user-guide/will-tab.md), where you can verify that each server has actually stored its copy.
|
||||
|
||||
## What happens from now on
|
||||
|
||||
- Keep using Electrum normally. The plugin watches your balance and asks you to refresh the will when it changes — see [Keeping the will up to date](../user-guide/updating.md).
|
||||
- If you enabled [Check Alive](../user-guide/check-alive.md) (advanced mode), opening your wallet after the threshold prompts you to postpone the delivery date.
|
||||
- If you stop opening Electrum, the Will-Executors broadcast the inheritance on the date you set.
|
||||
Reference in New Issue
Block a user