diff --git a/README.md b/README.md index 639b241..1f2227a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ AsciiDoc sources for the docs hosted at . +## New Contributors + +Bisq's [decentralized governance structure][3] makes documentation especially important. If you're interested in contributing: + +- Take a look at [existing docs][4] to get a feel for the general approach to format, tone, and detail +- Look through our [Contributor's Checklist][5] for a background on how we work and conventions (e.g., proper git commit messages) +- Correspond with existing contributors [on Slack^] to discuss your ideas or determine where help is most needed + ## Build To build locally, run `./gradlew build` (`gradlew.bat build --project-cache-dir=../cache` on Windows) and then open `build/asciidoc/html5/index.html` in your browser. @@ -17,3 +25,6 @@ Commits pushed to the `master` branch of this repository are automatically built [1]: https://asciidoctor.org/docs/user-manual [2]: https://chrome.google.com/webstore/detail/livereload/jnihajbhpnppcggbcgedagnkighmdlei +[3]: https://docs.bisq.network/user-dao-intro.html +[4]: https://docs.bisq.network +[5]: https://docs.bisq.network/contributor-checklist.html diff --git a/getting-started.adoc b/getting-started.adoc index 6524761..3498e5b 100644 --- a/getting-started.adoc +++ b/getting-started.adoc @@ -30,12 +30,12 @@ Once the installer is finished, go ahead and open Bisq. It'll take a few moments When that's done, the first screen you see should look something like this: -.Right half of the screen (gold-colored graph) shows outstanding offers you can take to buy bitcoin. That's what we'll be doing in this guide. +.Right half of the screen (green graph) shows outstanding offers you can take to buy bitcoin. That's what we'll be doing in this guide. image::market-screen.png[Market overview screen] == Configure a national currency account -Since we're looking to buy bitcoin, let's take a look at the `Buy BTC` screen. You should see a list of offers, but you'll notice all the orange `Take offer` buttons are disabled: +Since we're looking to buy bitcoin, let's take a look at the `Buy BTC` screen. You should see a list of offers, but you'll notice all the green `Take offer` buttons are disabled: .Before configuring a payment account: all offers are disabled. image::before-adding-fiat-account.png[Offers disabled before configuring national currency account] @@ -43,7 +43,7 @@ image::before-adding-fiat-account.png[Offers disabled before configuring nationa That's because we haven't yet configured a way to pay for the bitcoin we want to buy. So let's set up a payment method. Bisq works with many different payment methods, so you can choose those you already have access to and are most comfortable using. Keep in mind that payment methods determine: * which offers you can take right now (e.g., in the image above, Zelle has many existing offers, so if we set up Zelle, we could immediately take any of those offers) -* how quickly a trade can be completed (e.g., a bank transfer will go through quicker than a money order sent by mail; see https://bisq.network/faq/#5[details here^]) +* how quickly a trade can be completed (e.g., a bank transfer will go through quicker than a money order sent by mail; see https://bisq.network/faq/#How_long_does_a_trade_take[details here^]) [NOTE] .What if there are no existing offers for the payment method I want to use? @@ -125,7 +125,7 @@ Now that we've gotten setup out of the way, let's trade! .Select an offer you like. image::select-an-offer.png[Select an offer,400,400] -Back in the `Buy BTC` screen, click the orange `Take Offer` button for the offer you'd like to take. +Back in the `Buy BTC` screen, click the green `Take Offer` button for the offer you'd like to take. -- @@ -150,7 +150,7 @@ Bisq will tell you the address of the trade wallet and exactly how much to send [NOTE] .A multisig escrow transaction? How does that work? ==== -Bisq never takes custody of users' bitcoin or national currency funds—indeed there is no way it could, because Bisq is just software, not a company. The "escrow transaction" mentioned above is a _smart contract_—specifically a 2-of-3 multisignature Bitcoin transaction involving you, the seller, and a https://bisq.network/faq/#8[bonded arbitrator^]. More details are https://bisq.network/faq/#18[here^] and you can read more about multisig wallets https://en.bitcoin.it/wiki/Multisignature[here^]. +Bisq never takes custody of users' bitcoin or national currency funds—indeed there is no way it could, because Bisq is just software, not a company. The "escrow transaction" mentioned above is a _smart contract_—specifically a 2-of-3 multisignature Bitcoin transaction involving you, the seller, and a https://bisq.network/faq/#What_is_an_arbitrator[bonded arbitrator^]. You can read more about multisig wallets https://en.bitcoin.it/wiki/Multisignature[here^]. ==== === 3. Confirm trade @@ -232,15 +232,23 @@ Congratulations. You've just completed your first trade on Bisq! == Next steps +==== Security + It's *crucial* that you secure your Bisq wallet. Without a password, your wallet data is stored on your hard drive unencrypted. That's _dangerous_. Please follow our <> to set a password, encrypt your wallet, and securely store your wallet's recovery seed words. +==== Mobile Notifications + +There are points in the Bisq trading process when your attention is required, but what if you're not near your computer at those times? + +To solve this problem, you can get https://bisq.network/downloads/[Bisq's mobile notifications apps for iOS and Android^]. Once paired with your Bisq client, the app will send you a notification as soon as an offer is accepted, a payment is sent, etc. + == Get help and stay in touch If you get stuck, reach out! There's a community of people to help you on the https://bisq.community/[Bisq forum^], the https://www.reddit.com/r/bisq/[/r/bisq subreddit^], and the https://bisq.network/slack-invite[Bisq Slack team^]. -You can get news and updates about Bisq via https://twitter.com/bisq_network[Twitter^], https://www.facebook.com/bisqnetwork/[Facebook^], and https://www.youtube.com/c/bisq-network[YouTube^]. +You can get news and updates about Bisq via https://twitter.com/bisq_network[Twitter^] and https://www.youtube.com/c/bisq-network[YouTube^]. And if you really like Bisq, <>! Even if you're not a developer, there's much you can do. diff --git a/images/after-adding-fiat-account.png b/images/after-adding-fiat-account.png index c5eacca..a176153 100644 Binary files a/images/after-adding-fiat-account.png and b/images/after-adding-fiat-account.png differ diff --git a/images/before-adding-fiat-account.png b/images/before-adding-fiat-account.png index 7de41ed..70b5161 100644 Binary files a/images/before-adding-fiat-account.png and b/images/before-adding-fiat-account.png differ diff --git a/images/complete-trade.png b/images/complete-trade.png index 718798d..5d82728 100644 Binary files a/images/complete-trade.png and b/images/complete-trade.png differ diff --git a/images/configure-fiat-account.png b/images/configure-fiat-account.png index 714aa88..f576f76 100644 Binary files a/images/configure-fiat-account.png and b/images/configure-fiat-account.png differ diff --git a/images/confirm-deal.png b/images/confirm-deal.png index ab8091c..9630f67 100644 Binary files a/images/confirm-deal.png and b/images/confirm-deal.png differ diff --git a/images/deposit-details.png b/images/deposit-details.png index ebf0b54..1e47a01 100644 Binary files a/images/deposit-details.png and b/images/deposit-details.png differ diff --git a/images/fund-bisq-wallet.png b/images/fund-bisq-wallet.png index 1c88990..05a42aa 100644 Binary files a/images/fund-bisq-wallet.png and b/images/fund-bisq-wallet.png differ diff --git a/images/mark-payment-sent.png b/images/mark-payment-sent.png index f496c58..d52f2b2 100644 Binary files a/images/mark-payment-sent.png and b/images/mark-payment-sent.png differ diff --git a/images/market-screen.png b/images/market-screen.png index 3cc2f6a..c066e71 100644 Binary files a/images/market-screen.png and b/images/market-screen.png differ diff --git a/images/remaining-time-to-pay.png b/images/remaining-time-to-pay.png index d5df69f..945cdc5 100644 Binary files a/images/remaining-time-to-pay.png and b/images/remaining-time-to-pay.png differ diff --git a/images/seed-words.png b/images/seed-words.png index 9096064..8d51b94 100644 Binary files a/images/seed-words.png and b/images/seed-words.png differ diff --git a/images/select-an-offer.png b/images/select-an-offer.png index 5a0af3a..5c7a231 100644 Binary files a/images/select-an-offer.png and b/images/select-an-offer.png differ diff --git a/images/seller-payment-details.png b/images/seller-payment-details.png index cd4bd4e..ba46652 100644 Binary files a/images/seller-payment-details.png and b/images/seller-payment-details.png differ diff --git a/images/set-password.png b/images/set-password.png index a64d022..c94f038 100644 Binary files a/images/set-password.png and b/images/set-password.png differ diff --git a/secure-wallet.adoc b/secure-wallet.adoc index 0c828ac..228eec3 100644 --- a/secure-wallet.adoc +++ b/secure-wallet.adoc @@ -2,7 +2,7 @@ :imagesdir: images :!figure-caption: -As with traditional money and valuables, it's critical that you take reasonable measures to keep your bitcoin safe. This short guide will explain how you can secure your Bisq wallet by (1) encrypting it and (2) writing down its seed words so you can restore it later. +Bisq is a non-custodial exchange, which means you retain control of your funds. That also means you're in charge of securing your funds. This short guide will explain how you can secure your Bisq wallet by (1) encrypting it and (2) writing down its seed words so you can restore it later. == Encrypt your wallet @@ -23,7 +23,7 @@ IMPORTANT: You should _actually_ write down your seed words and wallet date usin With just your wallet's seed words and date, you can restore your Bisq wallet and all its bitcoin whenever you need to. If you lose your wallet's seed words and date, you won't be able to restore your wallet, and any bitcoin in it is lost forever. So make sure you keep that paper safe! -WARNING: Your seed words can restore your wallet's bitcoin, but they *do not* restore other Bisq application data such as trading history, arbitration cases, etc. For that, you need to back up the Bisq data folder. You can find out how to do that in the `Backup` section of the `Account` screen. +WARNING: Your seed words can restore your wallet's bitcoin, but they *do not* restore other Bisq application data such as your payment accounts, open disputes, etc. For that, you need to <>. .Write down your Bisq wallet's seed words & wallet date. image::seed-words.png[Write down your Bisq wallet's seed words]