Skip to content

Commit

Permalink
updated README file (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
truxxu authored Mar 1, 2024
1 parent c64bf93 commit 2f10485
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# Tatacoa Wallet

A non-custodial Bitcon wallet that makes use of Breez SDK.
A non-custodial Bitcon wallet powered by Breez SDK. Built on React Native and tested on Android.

Tatacoa Wallet includes the following features:

- Send and receive Bitcoin Lightning
- QR code scanning
- Invoice decoding
- Wallet recovery
- Copy invoice from/to clipboard
- Support for numerous fiat currencies
- Multilanguage support (ES, EN)

## TODOs

- [x] Send/receive Lightning
- [ ] LNURL-Auth
- [ ] On-chain support
- [ ] Submarine swaps

## Build

Set environment variables

```
// .env
BREEZ_API_KEY=***
DEVICE_KEY=***
DEVICE_CERTIFICATE_BASE64=***
DEVICE_KEY_BASE64=***
TATACOA_UPLOAD_STORE_FILE=tatacoa_nc_wallet.keystore
TATACOA_UPLOAD_KEY_ALIAS=nc_wallet
TATACOA_UPLOAD_STORE_PASSWORD=***
TATACOA_UPLOAD_KEY_PASSWORD=***
```

Set node version

$ nvm use

Install dependencies

$ yarn install

Run bundler [Metro](https://reactnative.dev/docs/metro)

$ yarn start --reset-cache

Launch application on device/emulator

$ yarn android

0 comments on commit 2f10485

Please sign in to comment.