From dd0e005b9d4826ab5509dcfdd38891f2f32f1356 Mon Sep 17 00:00:00 2001 From: Keith <74844722+keith-gardner@users.noreply.github.com> Date: Thu, 11 Dec 2025 08:43:58 -0500 Subject: [PATCH 1/5] Fix documentation link and add screenshots Updated documentation link and added new images. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d622e8f..b8dff7c 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,11 @@ Disclaimer: This is pre-release software and may contain bugs or incomplete features. Use at your own risk. Feedback and contributions are welcome! -Read more on our [documentation site.](https://developer.branta.pro/core) +Read more on our documentation site. + + + -Screenshot 2025-01-22 at 1 17 32 PM -Screenshot 2025-01-22 at 1 19 21 PM ## Feature Set From 6faa64b582f8f10a01d0b69d959f1ce4977ecef5 Mon Sep 17 00:00:00 2001 From: Kyle McCullen Date: Thu, 11 Dec 2025 15:22:13 -0500 Subject: [PATCH 2/5] update readme / docs --- README.md | 81 ++++++++++++++++------- docs/local_development/Linux.MD | 4 -- docs/local_development/release/Windows.md | 11 --- 3 files changed, 57 insertions(+), 39 deletions(-) delete mode 100644 docs/local_development/Linux.MD delete mode 100644 docs/local_development/release/Windows.md diff --git a/README.md b/README.md index b8dff7c..994cfd2 100644 --- a/README.md +++ b/README.md @@ -6,39 +6,72 @@

+Branta Core is a cross-platform desktop application that helps prevent address swaps by knotifying you of Bitcoin/Nostr related content in your clipboard. + +More information (and release binaries) can be found at https://branta.pro/core. Release binaries are also available directly from [GitHub](https://github.com/BrantaOps/core/releases). + +

Disclaimer: This is pre-release software and may contain bugs or incomplete features. Use at your own risk. Feedback and contributions are welcome! +

Read more on our documentation site. +## Setup +### Prerequisites -## Feature Set -- [X] Linux, Mac & Windows builds -- [X] Instant Clipboard alerts for Bitcoin & Lightning -- [X] Instant Clipboard alerts for NOSTR -- [X] Optional clipboard history -- [X] `P2TR` Wallets -- [X] `P2WPKH` Wallets -- [X] `P2WSH` Multisig Wallets -- [X] Zero analytics -- [X] Zero default network traffic -- [X] Change & Receive account clipboard alerts -- [X] Testnet support -- [ ] NOSTR preferences sync -- [X] BOLT 11 parsing -- [ ] Mobile Support +1. Node (>=22) +2. Npm (>=10) -## Download +### Clone the Repository +``` +git clone https://github.com/BrantaOps/core.git +``` - - - - - Get it from the Snap Store - - +### Install npm packages +``` +npm install +``` + +## Running +Running the app requirees both the frontend and backend to be ran simultaneously + +Angular frontend +``` +npm run ng:serve +``` + +Electron backend +``` +npm start +``` + +## Packaging + +- Update `package.json` version +- `npm run build` +- `npm run package` + +### Windows + +- Open `installers/windows/windows.sln` in Visual Studio +- Update `Package.wxs` version +- Update Solution Configruation option in toolbar from Debug to Release +- Build the solution +- MSI file can be found at `installers/windows/Branta.Wix/bin/x64/Release/en-US/Branta.Wix.msi` +- Update the name to match the version `branta-x.x.x.msi` + +### Linux + +TODO + +### Mac + +TODO + +## Reporting Issues -[![branta](https://snapcraft.io/branta/badge.svg)](https://snapcraft.io/branta) +Please use the [Issues](https://github.com/BrantaOps/core/issues) tab above to report an issue. \ No newline at end of file diff --git a/docs/local_development/Linux.MD b/docs/local_development/Linux.MD deleted file mode 100644 index 1e256c3..0000000 --- a/docs/local_development/Linux.MD +++ /dev/null @@ -1,4 +0,0 @@ -##### Linux -```bash -$ sudo apt install rpm -``` diff --git a/docs/local_development/release/Windows.md b/docs/local_development/release/Windows.md deleted file mode 100644 index 56b5b05..0000000 --- a/docs/local_development/release/Windows.md +++ /dev/null @@ -1,11 +0,0 @@ -# Releasing Steps - -- Update `package.json` version -- `npm run build` -- `npm run package` -- Open `installers/windows/windows.sln` in Visual Studio -- Update `Package.wxs` version -- Update Solution Configruation option in toolbar from Debug to Release -- Build the solution -- MSI file can be found at `installers/windows/Branta.Wix/bin/x64/Release/en-US/Branta.Wix.msi` -- Update the name to match the version `branta-x.x.x.msi` From d8748d940c04aaf4a3cdf4f8f702d07f8ded5724 Mon Sep 17 00:00:00 2001 From: Kyle McCullen Date: Thu, 11 Dec 2025 15:27:51 -0500 Subject: [PATCH 3/5] combine links text, update red text to md warning --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 994cfd2..58e97f1 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,12 @@ Branta Core is a cross-platform desktop application that helps prevent address swaps by knotifying you of Bitcoin/Nostr related content in your clipboard. -More information (and release binaries) can be found at https://branta.pro/core. Release binaries are also available directly from [GitHub](https://github.com/BrantaOps/core/releases). - -

-Disclaimer: This is pre-release software and may contain bugs or incomplete features. Use at your own risk. Feedback and contributions are welcome! -

- +Release binaries and additional information are available at https://branta.pro/core and directly from [GitHub](https://github.com/BrantaOps/core/releases). Read more on our documentation site. +> [!WARNING] +> This is pre-release software and may contain bugs or incomplete features. Use at your own risk. Feedback and contributions are welcome! + From 1c2108a915a3fb6ca237220ee5aef80a0ce33de3 Mon Sep 17 00:00:00 2001 From: Kyle McCullen Date: Thu, 11 Dec 2025 15:29:53 -0500 Subject: [PATCH 4/5] delete changelog --- CHANGELOG.md | 23 ----------------------- 1 file changed, 23 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 424016b..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,23 +0,0 @@ -# 0.6.0 - 11/1/2024 - - Testnet Support - - Add Icon: Unchained - - Add bitcoin logo icon color options - - Do not allow identically named Wallets - - Add Wallet: Accept Descriptor - - Support Change Addresses - - Style Improvements - - Support P2TR - - Add Icon: Trezor - -# 0.5.0 - 10/6/2024 - - Persist history, allow user to hide and clear - - Display wallet icon on Clipboard Details component - - Refire Clipboard check when a wallet, vault or setting changes - - Bug fixes - -# 0.4.0 - 10/3/2024 - - M of N Limit 15 - - Update UI of wallets to match Vaults - - Logo picker for Wallets - - Improve add Wallet form with stepper and address verification - From adfcb14c115e62fd9c353eb3730027072ba44774 Mon Sep 17 00:00:00 2001 From: Kyle McCullen Date: Thu, 11 Dec 2025 15:50:15 -0500 Subject: [PATCH 5/5] typo and formatting --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 58e97f1..5d03d61 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

-Branta Core is a cross-platform desktop application that helps prevent address swaps by knotifying you of Bitcoin/Nostr related content in your clipboard. +Branta Core is a cross-platform desktop application that helps prevent address swaps by notifying you of Bitcoin/Nostr related content in your clipboard. Release binaries and additional information are available at https://branta.pro/core and directly from [GitHub](https://github.com/BrantaOps/core/releases). Read more on our documentation site. @@ -25,24 +25,29 @@ Read more on our