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 - diff --git a/README.md b/README.md index d622e8f..5d03d61 100644 --- a/README.md +++ b/README.md @@ -6,38 +6,75 @@

-Disclaimer: This is pre-release software and may contain bugs or incomplete features. Use at your own risk. Feedback and contributions are welcome! +Branta Core is a cross-platform desktop application that helps prevent address swaps by notifying you of Bitcoin/Nostr related content in your clipboard. -Read more on our [documentation site.](https://developer.branta.pro/core) +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. -Screenshot 2025-01-22 at 1 17 32 PM -Screenshot 2025-01-22 at 1 19 21 PM +> [!WARNING] +> This is pre-release software and may contain bugs or incomplete features. Use at your own risk. Feedback and contributions are welcome! + + -## 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 +## Setup -## Download +### Prerequisites - - - - - Get it from the Snap Store - - +1. Node (>=22) +2. Npm (>=10) + +### Clone the Repository + +``` +git clone https://github.com/BrantaOps/core.git +``` + +### 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.