Merge #3132 #3149

3132: chore: Update README.md r=klochowicz a=klochowicz - mention how to use `homebrew` - mention existence of the desktop app - update bitcoin node distros support list 3149: chore(deps-dev): Bump sass-loader from 13.0.2 to 13.1.0 in /crates/taker-electron r=klochowicz a=dependabot[bot] Bumps [sass-loader](https://github.com/webpack-contrib/sass-loader) from 13.0.2 to 13.1.0. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/webpack-contrib/sass-loader/releases">sass-loader's releases</a>.</em></p> <blockquote> <h2>v13.1.0</h2> <h2><a href="https://github.com/webpack-contrib/sass-loader/compare/v13.0.2...v13.1.0">13.1.0</a> (2022-10-06)</h2> <h3>Features</h3> <ul> <li>allow to extend <code>conditionNames</code> (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1092">#1092</a>) (<a href="https://github.com/webpack-contrib/sass-loader/commit/6e02c64da80e3c8b3b6399923b7268aaf957d2cb">6e02c64</a>)</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/webpack-contrib/sass-loader/blob/master/CHANGELOG.md">sass-loader's changelog</a>.</em></p> <blockquote> <h2><a href="https://github.com/webpack-contrib/sass-loader/compare/v13.0.2...v13.1.0">13.1.0</a> (2022-10-06)</h2> <h3>Features</h3> <ul> <li>allow to extend <code>conditionNames</code> (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1092">#1092</a>) (<a href="https://github.com/webpack-contrib/sass-loader/commit/6e02c64da80e3c8b3b6399923b7268aaf957d2cb">6e02c64</a>)</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/b31751dc173c64d0b3230efc928dbdcd378d9c8f"><code>b31751d</code></a> chore(release): 13.1.0</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/6e02c64da80e3c8b3b6399923b7268aaf957d2cb"><code>6e02c64</code></a> feat: allow to extend <code>conditionNames</code> (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1092">#1092</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/edab08fa9d13097170d74bea2a0e19f246c96d2a"><code>edab08f</code></a> chore: update dependencies to the latest version (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1093">#1093</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/3a34fefe69665f9e9cd47a550037b375f134e0ed"><code>3a34fef</code></a> chore: update commitlint action (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1091">#1091</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/52584cfb99fa8094558ac6091b363b97381edf50"><code>52584cf</code></a> chore: run cancel workflow on pull request (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1089">#1089</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/8c8cece124f33f373dfffcab651dc0fa2fb34285"><code>8c8cece</code></a> chore: update jest to the latest version (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1088">#1088</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/8ae327d4e29324e32218b37953c36d58341886f4"><code>8ae327d</code></a> chore: update dependencies to the latest version (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1086">#1086</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/a327414456313ac9ec3c1427c0c2845a61aa0018"><code>a327414</code></a> ci: update github workflow security permissions (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1087">#1087</a>)</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/6b01c64bcfea5f32521d7eef86a1f1361ed612a3"><code>6b01c64</code></a> docs: include file loader method of extracting CSS as separate file in README...</li> <li><a href="https://github.com/webpack-contrib/sass-loader/commit/78c059043144b36ecba3c2963e91129e5bcc26e3"><code>78c0590</code></a> ci: add job to cancel previous runs (<a href="https://github-redirect.dependabot.com/webpack-contrib/sass-loader/issues/1083">#1083</a>)</li> <li>Additional commits viewable in <a href="https://github.com/webpack-contrib/sass-loader/compare/v13.0.2...v13.1.0">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=sass-loader&package-manager=npm_and_yarn&previous-version=13.0.2&new-version=13.1.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting ``@dependabot` rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - ``@dependabot` rebase` will rebase this PR - ``@dependabot` recreate` will recreate this PR, overwriting any edits that have been made to it - ``@dependabot` merge` will merge this PR after your CI passes on it - ``@dependabot` squash and merge` will squash and merge this PR after your CI passes on it - ``@dependabot` cancel merge` will cancel a previously requested merge and block automerging - ``@dependabot` reopen` will reopen this PR if it is closed - ``@dependabot` close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - ``@dependabot` ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - ``@dependabot` ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - ``@dependabot` ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Co-authored-by: Mariusz Klochowicz <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
get10101 · Oct 10, 2022 · bd0abaa · bd0abaa
3 parents 8864c31 + 957c5a3 + 4a73319
commit bd0abaa
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -11,27 +11,54 @@ Here is some material to read up on DLCs and ItchySats' protocol implementation:
 - [Blogpost](https://comit.network/blog/2022/01/11/cfd-protocol-explained) by @luckysori of the COMIT team, describing the protocol in detail
 - [DLC overview](https://bitcoinops.org/en/topics/discreet-log-contracts/) on Bitcoin Optech for information beyond ItchySats
 
+## Installation
+
+### Bitcoin/Lightning nodes
+
+ItchySats is available on many DIY Bitcoin/Lightning node distributions:
+
+- [RaspiBlitz](https://github.com/rootzoll/raspiblitz#feature-overview)
+- [Umbrel](https://getumbrel.com/)
+- [Citadel](https://runcitadel.space/)
+
+### Desktop App
+
+We package ItchySats as an Electron app for Windows and MacOS.
+The latest release can be found [here](https://github.com/itchysats/itchysats/releases/latest).
+
+### Homebrew (macOS)
+
+We maintain a [homebrew](https://brew.sh/) tap with the latest version of ItchySats.
+
+```sh
+brew tap itchysats/itchysats
+brew install itchysats
+```
+
+After the initial install, homebrew will take care of keeping ItchySats up-to-date.
+
+### Mobile
+
+ItchySats is not available as a full mobile app yet.
+In the meantime, if you'd like to use ItchySats on-the-go, the best way is to install ItchySats on your bitcoin node and use
+[Tailscale](https://tailscale.com/) or connect to your node via Tor.
+
 ## Quickstart: Users / Traders
 
 This guide is for how to use ItchySats as a taker.
 Currently, ItchySats does not officially support multiple makers.
 Please note that trade execution is already fully peer to peer, but there is currently only one maker out there.
 We are working on adding support for maker discovery and trading with multiple makers for a more competitive market.
 
-ItchySats is available in the [Umbrel](getumbrel.com/) appstore.
-ItchySats is available as bonus features on [RaspiBlitz](https://github.com/rootzoll/raspiblitz#feature-overview).
-
-We recommend using ItchySats on Umbrel or RaspiBlitz for the time being.
-
-If you want to try ItchySats without Umbrel you can use the [latest binary](github.com/itchysats/itchysats/releases/latest) or [latest docker container](https://github.com/itchysats/itchysats/pkgs/container/itchysats%2Ftaker) but that might not be as straightforward.
-
 To open a position:
 
-1. Install the App on Umbrel (or start the binary / container)
-2. Transfer funds into the ItchySats wallet
-3. Open a `long` or `short` position - this will lock the funds in a multisig on chain
-4. Wait for the price to move
-5. Close the position - this will spend the locked up funds according to the price
+1. Open ItchySats.
+2. Unlock ItchySats by typing in the default password (`weareallsatoshi` - except for Umbrel, where it depends on its seed and is visible in the AppStore).
+3. Choose your own secure password. Don't forget to store it securely; there's no way to reset it without removing the ItchySats database.
+4. Transfer funds into the ItchySats wallet.
+5. Open a `long` or `short` position - this will lock the funds in a multisig on chain.
+6. Wait for the price to move.
+7. Close the position - this will spend the locked up funds according to the price.
 
 With the current maker you can close positions at any point in time.
 Trades are limited to a contract size between `100` and `1000` contracts.

diff --git a/crates/taker-electron/package.json b/crates/taker-electron/package.json
@@ -69,7 +69,7 @@
     "react-refresh": "^0.14.0",
     "react-test-renderer": "^18.2.0",
     "sass": "^1.54.4",
-    "sass-loader": "^13.0.2",
+    "sass-loader": "^13.1.0",
     "style-loader": "^3.3.1",
     "terser-webpack-plugin": "^5.3.5",
     "ts-loader": "^9.3.1",

diff --git a/crates/taker-electron/yarn.lock b/crates/taker-electron/yarn.lock
@@ -8332,10 +8332,10 @@ sanitize-filename@^1.6.3:
   dependencies:
     truncate-utf8-bytes "^1.0.0"
 
-sass-loader@^13.0.2:
-  version "13.0.2"
-  resolved "https://registry.yarnpkg.com/sass-loader/-/sass-loader-13.0.2.tgz#e81a909048e06520e9f2ff25113a801065adb3fe"
-  integrity sha512-BbiqbVmbfJaWVeOOAu2o7DhYWtcNmTfvroVgFXa6k2hHheMxNAeDHLNoDy/Q5aoaVlz0LH+MbMktKwm9vN/j8Q==
+sass-loader@^13.1.0:
+  version "13.1.0"
+  resolved "https://registry.yarnpkg.com/sass-loader/-/sass-loader-13.1.0.tgz#e5b9acf14199a9bc6eaed7a0b8b23951c2cebf6f"
+  integrity sha512-tZS1RJQ2n2+QNyf3CCAo1H562WjL/5AM6Gi8YcPVVoNxQX8d19mx8E+8fRrMWsyc93ZL6Q8vZDSM0FHVTJaVnQ==
   dependencies:
     klona "^2.0.4"
     neo-async "^2.6.2"