BlueWallet/README.md
Marcos Rodriguez Vélez 76d889752a Add instructions for iOS
2019-10-28 22:55:11 +00:00

93 lines
2.7 KiB
Markdown

# BlueWallet - A Bitcoin & Lightning Wallet
[![GitHub tag](https://img.shields.io/badge/dynamic/json.svg?url=https://raw.githubusercontent.com/BlueWallet/BlueWallet/master/package.json&query=$.version&label=Version)](https://github.com/BlueWallet/BlueWallet)
[![CircleCI](https://circleci.com/gh/BlueWallet/BlueWallet.svg?style=svg)](https://circleci.com/gh/BlueWallet/BlueWallet)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![](https://img.shields.io/github/license/BlueWallet/BlueWallet.svg)
Thin Bitcoin Wallet.
Built with React Native and BlockCypher API.
[![Appstore](https://bluewallet.io/img/app-store-badge.svg)](https://itunes.apple.com/us/app/bluewallet-bitcoin-wallet/id1376878040?l=ru&ls=1&mt=8)
[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=io.bluewallet.bluewallet)
Website: [bluewallet.io](http://bluewallet.io)
Community: [telegram group](https://t.me/bluewallet)
* Private keys never leave your device
* Lightning Network supported
* SegWit-first. Replace-By-Fee support
* Encryption. Plausible deniability
* And many more [features...](https://bluewallet.io/features.html)
<img src="https://i.imgur.com/hHYJnMj.png" width="100%">
## BUILD & RUN IT
* In your console:
```
git clone https://github.com/BlueWallet/BlueWallet.git
cd BlueWallet
npm install
```
* To run on Android:
```
npm start android
```
* To run on iOS:
```
cd ios
pod install
cd ..
npm start ios
```
## TESTS
```bash
npm run test
```
## QA
Builds automated and tested with BrowserStack
<a href="https://www.browserstack.com/"><img src="https://i.imgur.com/syscHCN.png" width="160px"></a>
## MOTIVATION TO BUILD IT
I was not satisfied with existing iOS Bitcoin apps, especially with BreadWallet (the one I mainly used) where development stalled and they could not even deliver such features as SegWit, RBF and custom fees (at the times where custom fees were especially needed).
So I knew I could create one to use myself and let others use it.
I had experience with awesome bitcoin-js lib (javascript), and since I dont own any Macs, don't plan to and not going to learn ObjC/Swift - ReactNative (where you also write in javascript) was an obvious choice.
## LICENSE
MIT
## WANT TO CONTRIBUTE?
Grab an issue from [the backlog](https://github.com/BlueWallet/BlueWallet/projects/1), try to start or submit a PR, any doubts we will try to guide you.
Join us at our [telegram group](https://t.me/bluewallet) where we hangout :+1:
## Responsible disclosure
Found critical bugs/vulnerabilities? Please email them bluewallet@bluewallet.io
Thanks!