BlueWallet/README.md

67 lines
2.3 KiB
Markdown
Raw Normal View History

2018-12-21 23:36:59 +01:00
# BlueWallet - A Bitcoin & Lightning Wallet
2018-01-30 23:42:38 +01:00
2018-12-24 22:16:46 +01:00
[![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)
2018-09-26 21:03:44 +02:00
[![CircleCI](https://circleci.com/gh/BlueWallet/BlueWallet.svg?style=svg)](https://circleci.com/gh/BlueWallet/BlueWallet)
2018-07-07 23:19:10 +02:00
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
2018-12-24 22:16:46 +01:00
![](https://img.shields.io/github/license/BlueWallet/BlueWallet.svg)
2018-03-18 04:19:06 +01:00
2018-01-30 23:42:38 +01:00
Thin Bitcoin Wallet.
2018-12-12 00:38:58 +01:00
Built with React Native and BlockCypher API.
2018-01-30 23:42:38 +01:00
2018-12-20 19:05:26 +01:00
[![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)
2018-05-12 22:39:54 +02:00
2018-06-03 13:53:34 +02:00
Website: [bluewallet.io](http://bluewallet.io)
2018-12-22 17:31:47 +01:00
Community: [telegram group](https://t.me/bluewallet)
2018-06-03 13:53:34 +02:00
2018-01-30 23:42:38 +01:00
* Private keys never leave your device
2018-12-20 19:05:26 +01:00
* Lightning Network supported
2018-01-30 23:42:38 +01:00
* SegWit-first. Replace-By-Fee support
2018-04-28 21:31:56 +02:00
* Encryption. Plausible deniability
2018-12-20 19:05:26 +01:00
* And many more [features...](https://bluewallet.io/features.html)
2018-01-30 23:42:38 +01:00
2018-05-12 22:39:54 +02:00
Beta version, do not use to store large amounts!
2018-12-20 19:05:26 +01:00
<img src="https://i.imgur.com/hHYJnMj.png" width="100%">
2018-02-02 21:54:10 +01:00
2018-01-30 23:42:38 +01:00
2018-04-28 21:31:56 +02:00
## BUILD & RUN IT
2018-01-30 23:42:38 +01:00
* In your console:
```
2018-10-03 15:17:30 +02:00
git clone https://github.com/BlueWallet/BlueWallet.git
2018-01-30 23:42:38 +01:00
cd BlueWallet
npm install
2018-12-12 00:38:58 +01:00
npm start android
2018-01-30 23:42:38 +01:00
```
2018-06-03 13:53:34 +02:00
## TESTS
```bash
npm run test
```
2018-02-10 20:23:46 +01:00
## 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.
2018-01-30 23:42:38 +01:00
## LICENSE
MIT
2018-12-23 17:42:46 +01:00
## WANT TO CONTRIBUTE?
2018-01-30 23:42:38 +01:00
2018-12-20 19:05:26 +01:00
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.
2018-12-22 17:31:47 +01:00
Join us at our [telegram group](https://t.me/bluewallet) where we hangout :+1: