Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #43 from hodlwallet/update-readme
Update readme
  • Loading branch information
igorgue committed Aug 27, 2019
2 parents d3af54b + d5ca2ec commit 5c18b76
Showing 1 changed file with 74 additions and 33 deletions.
107 changes: 74 additions & 33 deletions README.md
@@ -1,47 +1,88 @@
![ƀ](/images/icon.png) breadwallet for Android
----------------------------------
## [Hodl Wallet](https://hodlwallet.com/) - The easy and secure bitcoin wallet for Android

[![download](/images/icon-google-play.png)]
(https://play.google.com/store/apps/details?id=co.hodlwallet)
[![download](/images/icon-google-play.png)](https://play.google.com/store/apps/details?id=co.hodlwallet)

###bitcoin done right
### Bitcoin done right

This is the Android port of the breadwallet iOS app, which can be found [here](https://github.co/hodlwallet/breadwallet/).
This is the Android port of the Hodl Wallet iOS app, which can be found [here](https://github.com/hodlwallet/hodl-wallet-ios).

#####a completely standalone bitcoin wallet:
### A completely standalone Bitcoin wallet

Unlike many other bitcoin wallets, breadwallet is a real standalone bitcoin
client. There is no server to get hacked or go down, so you can always access
your money. Using
[SPV](https://en.bitcoin.it/wiki/Thin_Client_Security#Header-Only_Clients)
mode, breadwallet connects directly to the bitcoin network with the fast
performance you need on a mobile device.
Unlike other Andriod Bitcoin wallets, **Hodl** is a standalone Bitcoin client. It connects directly to the Bitcoin network using [SPV](https://en.bitcoin.it/wiki/Thin_Client_Security#Header-Only_Clients) mode, and doesn't rely on servers that can be hacked or disabled. Even if **Hodl** disappears, the app will continue to function, allowing users to access their money at any time. You can also recover **Hodl's** backup up recovery key in other Bitcoin wallets if necessary as we follow BIP standards for wallet generation.

#####the next step in wallet security:
### The next step in wallet security

breadwallet is designed to protect you from malware, browser security holes,
*even physical theft*. With AES hardware encryption, app sandboxing, and verified boot, breadwallet represents a significant security advance over
web and desktop wallets.
**Hodl** utilizes AES hardware encryption, app sandboxing, and the latest iOS security features to protect users from malware, browser security holes, and even physical theft. Private keys are stored only in the secure enclave of the user's phone, inaccessible to anyone other than the user.

#####beautiful simplicity:
### Simple yet robust

Simplicity is breadwallet's core design principle. A simple backup phrase is
all you need to restore your wallet on another device if yours is ever lost or
broken. Because breadwallet is
[deterministic](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki),
your balance and transaction history can be recovered from just your backup
phrase.
Simplicity and ease-of-use is **Hodl**'s core design principle. A simple recovery phrase (which we call a Backup Recovery Key) is all that is needed to restore the user's wallet if they ever lose or replace their device. **Hodl** is [deterministic](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki), which means the user's balance and transaction history can be recovered just from the backup recovery key.

###features:
### Features

- ["simplified payment verification"](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki) for fast mobile performance
- no server to get hacked or go down
- single backup phrase that works forever
- private keys never leave your device
- import [password protected](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki) paper wallets
- ["payment protocol"](https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki) payee identity certification
- [Simplified payment verification](https://github.com/bitcoin/bips/blob/master/bip-0037.mediawiki) for fast mobile performance
- No server to get hacked or go down
- Single backup phrase that works forever
- Private keys never leave your device
- Import [password protected](https://github.com/bitcoin/bips/blob/master/bip-0038.mediawiki) paper wallets
- [Payment protocol](https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki) payee identity certification

##How to set up the development environment:
### Localization

**Hodl** is available in the following languages:

- Chinese (Simplified and traditional)
- Danish
- Dutch
- English
- French
- German
- Italian
- Japanese
- Korean
- Portuguese
- Russian
- Spanish
- Swedish


### Recovering your funds with other Bitcoin Wallets.

It may be necessary at somepoint to recover your bitcoin via your Hodl Wallet Backup Recovery Key (seed) using another Bitcoin wallet. In this case it is important to know what path Hodl Wallet derives your keys from.

### Derivation path

Hodl Wallet conforms to [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) standards when generating your wallet.

Derivation Path - `m/0'`

### Recovering funds with Electrum

If you find yourself with the need to recvor your funds with an external app, Hodl Wallet reccomends [Electrum](https://electrum.org/#home).

It's important that you make sure you our downloading Electrum from the real source. You can do this by double checking the ssl certificate at the site or building from source.

Steps to recovering your bitcoin using Electrum:

1. Select New/Restore
2. Name the Wallet
3. Select Standard Wallet
4. Select "I have the seed"
5. In options select BIP39
6. Enter the seed
7. Select Path `m/0'`

**NOTE:** If you wish to recover funds in legacy addresses you must repeat the process in Electrum while the existing wallet showing your balance in the segwit addresses is open. Do this by selecting File --> New/Restore. Electrum allows a user to manage multiple wallets and seeds at once.


### Contact

Should you need to get in contact with us for any reason please feel free to write us at support@hodlwallet.com

You can visit our site here: [Hodlwallet.com](https://hodlwallet.com/)


## How to set up the development environment:
1. Download and install Java 7 or up
2. Download and Install the latest Android studio
3. Download and install the latest NDK https://developer.android.com/ndk/downloads/index.html or download it in android studio by "choosing the NDK" and press "download"
Expand All @@ -50,4 +91,4 @@ phrase.
6. Go to SDK Manager and download all the SDK Platforms and SDK Tools
7. Initialize the submodules - <code>git submodule init</code>
8. Update the submodules - <code>git submodule update</code>
9. Build -> Rebuild Project
9. Build -> Rebuild Project

0 comments on commit 5c18b76

Please sign in to comment.